Clearer description of elements regarding mapping order #144374
+1
−1
Conversation
This file contains hidden or 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
The original wording of 'The list is ordered from first-searched to last-searched' contains a slight ambiguity hence adds cognitive load for a reader, e.g., 'first-searched [...What?]'. This fixes "dangling modifier" (adjective without a noun) and decreases the cognitive load with the cost of adding one word with hyphen. It also designates the elements to 'mapping' which is consistent with the preceding sentence: "A user updateable list of mappings. " , which should benefit readers as well.
|
All commit authors signed the Contributor License Agreement. |
bedevere-app
bot
added
docs
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
The original wording of 'The list is ordered from first-searched to last-searched' contains a slight ambiguity hence adds cognitive load for a reader, e.g., 'first-searched [...What?]'.
This fixes "dangling modifier" (adjective without a noun) and decreases the cognitive load with the cost of adding one word with hyphen. It also designates the elements to 'mapping' which is consistent with the preceding sentence: "A user updateable list of mappings. " , which should benefit readers as well.
(No issue number for this pull request as this is a trivial, yet helpful hopefully, change)
📚 Documentation preview 📚: https://cpython-previews--144374.org.readthedocs.build/