Improve consumer doc

jenkinsci · Dec 19, 2020 · 86dc8e3 · 86dc8e3
1 parent a45182e
commit 86dc8e3
Showing 1 changed file with 3 additions and 2 deletions.
diff --git a/docs/consumers-guide.md b/docs/consumers-guide.md
@@ -45,10 +45,11 @@ The factory will iterate all available implementations of the `ChecksPublisher`
 
 ## Pipeline Step: withChecks
 
-The withChecks step injects a `ChecksInfo` object into its closure so that other plugin developers can resolve them in their [Step](https://javadoc.jenkins.io/plugin/workflow-step-api/org/jenkinsci/plugins/workflow/steps/Step.html) implementation:
+The `withChecks` step injects a `ChecksInfo` object into its closure so that other plugin developers can resolve them in their [Step](https://javadoc.jenkins.io/plugin/workflow-step-api/org/jenkinsci/plugins/workflow/steps/Step.html) implementation:
 
 ```
 getContext().get(ChecksInfo.class)
 ```
 
-Currently, the `ChecksInfo` object only includes a `name` specified by users.
+Currently, the `ChecksInfo` object only includes a `name` specified by users,
+it is recommended that you look for this name and set it over your default checks name