use present tense for porting guide entries #74021
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
ansibot
added
affects_2.11
core_review
abadger
reviewed
Mar 24, 2021
abadger
reviewed
Mar 24, 2021
samccann
approved these changes
Mar 24, 2021
ansibot
added
shipit
nitzmahone
approved these changes
Mar 24, 2021
There was a problem hiding this comment.
+1
I'm not sure I knew we had a style guide, but that's very helpful! In previous lives, active voice, and especially "you", were expressly prohibited in docs, so it's good to know that we're doing something different. I'll try to adjust the editing/muscle memory accordingly ;)
ansibot
added
core_review
Co-authored-by: Toshio Kuratomi <a.badger@gmail.com>
samccann
approved these changes
Mar 25, 2021
ansibot
added
needs_ci
samccann
removed
the
needs_triage
bcoca
pushed a commit
to bcoca/ansible
that referenced
this pull request
Apr 6, 2021
Co-authored-by: Toshio Kuratomi <a.badger@gmail.com> Co-authored-by: Sandra McCann <samccann@redhat.com>
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
SUMMARY
Updates the porting guide for ansible-core 2.11 to avoid future tense, in accordance with the Ansible style guide.
The entry about validating
choicesillustrates the confusion that future tense can cause: the old text says "any settings that currently violate it and are currently ignored will now cause an error". Here "currently" means "in 2.10" and "now" means "in 2.11", but "currently" and "now" also mean the same thing. This is confusing enough in English, unless you know the context well. Translation would be difficult.ISSUE TYPE
COMPONENT NAME
porting guides
docs.ansible.com