Docs: Update sentence structure in user guide #42884
Conversation
This commit fixes a grammatically incorrect sentence in Introduction to Playbook Section under User Guide.
ansibot
added
affects_2.7
| @@ -160,7 +160,7 @@ Support for running things as another user is also available (see :doc:`become`) | |||
| remote_user: yourname | |||
| become: yes | |||
|
|
|||
| You can also use become on a particular task instead of the whole play:: | |||
There was a problem hiding this comment.
You can rephrase this as -
You can also use keyword 'become' on a particular task instead of the whole play
There was a problem hiding this comment.
Yeah that suits better.
There was a problem hiding this comment.
I have updated the sentence now. Thanks @Akasurde for the suggestion
Akasurde
removed
the
needs_triage
ansibot
added
the
needs_revision
There was a problem hiding this comment.
Hi @taranjeet, thank you for reading the documentation so carefully and for submitting a PR. We're committed to making the Ansible documentation world-class, and user feedback is an important part of that effort.
I think this change would be stronger if the word become were formatted as code - in rST, you do that with double back-ticks before and after the word.
For future documentation suggestions, please include a sentence or two in the PR letting us know what you found confusing or incorrect about the original wording. This will help us review and revise the user documentation.
This commit fixes the information about become keyword in Introduction to Playbook part under User Guide.
|
@acozine : I have updated the |
|
@taranjeet Thanks for the contribution. @bcoca @acozine Thanks for the review. |
SUMMARY
This commit fixes a grammatically incorrect sentence in
Introduction to Playbook Section under User Guide.
ISSUE TYPE
COMPONENT NAME
User Guide > Introduction to Playbooks