From ab59b28c4fde2b93ee73dac0edec0724d41aa21d Mon Sep 17 00:00:00 2001 From: Cricket Liu Date: Sun, 8 Sep 2019 00:26:16 -0700 Subject: [PATCH] Making cancel's README consistent with other plugins' READMEs (#3253) --- plugin/cancel/README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/plugin/cancel/README.md b/plugin/cancel/README.md index 1615f6409..9f7c470d9 100644 --- a/plugin/cancel/README.md +++ b/plugin/cancel/README.md @@ -2,14 +2,14 @@ ## Name -*cancel* - a plugin that cancels a request's context after 5001 milliseconds. +*cancel* - cancels a request's context after 5001 milliseconds. ## Description The *cancel* plugin creates a canceling context for each request. It adds a timeout that gets triggered after 5001 milliseconds. -The 5001 number is chosen because the default timeout for DNS clients is 5 seconds, after that they +The 5001 number was chosen because the default timeout for DNS clients is 5 seconds, after that they give up. A plugin interested in the cancellation status should call `plugin.Done()` on the context. If the