DOC: Remove space after directive name, before double-colon #24927
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
While Sphinx/Docutils allow space after the directive name, it is not in the spec and not supported by all Rst parsers. Those are also the only 3 place in the codebase I could find that use space after a directive name.
dstansby
approved these changes
Jan 10, 2023
meeseeksmachine
pushed a commit
to meeseeksmachine/matplotlib
that referenced
this pull request
Jan 10, 2023
… before double-colon
|
❤️ You are on fire for 2023. |
oscargus
added a commit
that referenced
this pull request
Jan 10, 2023
…927-on-v3.7.x Backport PR #24927 on branch v3.7.x (DOC: Remove space after directive name, before double-colon)
|
@meeseeksdev backport to v3.6.x |
meeseeksmachine
pushed a commit
to meeseeksmachine/matplotlib
that referenced
this pull request
Jan 11, 2023
… before double-colon
QuLogic
added a commit
that referenced
this pull request
Jan 11, 2023
…927-on-v3.6.x Backport PR #24927 on branch v3.6.x (DOC: Remove space after directive name, before double-colon)
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.
While Sphinx/Docutils allow space after the directive name, it is not in the spec and not supported by all Rst parsers.
Those are also the only 3 place in the codebase I could find that use space after a directive name.
PR Checklist
Documentation and Tests
pytestpasses)Release Notes
.. versionadded::directive in the docstring and documented indoc/users/next_whats_new/.. versionchanged::directive in the docstring and documented indoc/api/next_api_changes/next_whats_new/README.rstornext_api_changes/README.rst