Normalize RST labels to remove duplicates (for one option) #7
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
…on algorithm as docutils internally uses.
briantist
approved these changes
Apr 27, 2022
There was a problem hiding this comment.
(as discussed in IRC) I would just add the reasoning for the urlencode change to changelog, otherwise this is great!
Context for other readers: https://docs.ansible.com/ansible/latest/collections/amazon/aws/aws_s3_module.html#parameter-s3_url
This module has an option with an alias that differs only in case, while RST treats labels as case insensitive, so it results in a duplicate which cases a warning.
|
@briantist thanks for reviewing! |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
docutils normalizes labels to targets by making them lowercase and normalizing whitespace. We do this for all labels for an option to avoid collisions. (You can still have collisions if you have two distinct options that differ by case, for example.)