馃摑 docs: name force_refs_lower correctly in changelog - #348
Merged
Conversation
The unreleased entry says force_args_lower, but the directive registers force_refs_lower and the README documents that name. Copying the option from the changelog produced an unknown option error.
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
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 unreleased changelog entry names the directive option
force_args_lower, while the option_logic.pyregisters and the README documents isforce_refs_lower. A reader copying the name from the changelog gets an "unknown option" error from docutils. 馃摑 This corrects the entry to match the code.