FazBrowse GitHub Viewer | Trending |
URL:
| Home
Tools: [Download Repo ZIP]   [Original HTTPS Page]

DOC: Remove space after directive name, before double-colon by Carreau · Pull Request #24927 · matplotlib/matplotlib · GitHub

Repository navigation

DOC: Remove space after directive name, before double-colon - #24927

Merged
oscargus merged 1 commit into
matplotlib:mainfrom
Carreau:no-space
Jan 10, 2023
Merged

oscargus merged 1 commit into
matplotlib:mainfrom
Carreau:no-space

Conversation

Carreau commented Jan 10, 2023

Copy link
Copy Markdown
Contributor

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

  • [N/A] Has pytest style unit tests (and pytest passes)
  • Documentation is sphinx and numpydoc compliant (the docs should build without error).
  • [N/A] New plotting related features are documented with examples.

Release Notes

  • [N/A] New features are marked with a .. versionadded:: directive in the docstring and documented in doc/users/next_whats_new/
  • [N/A] API changes are marked with a .. versionchanged:: directive in the docstring and documented in doc/api/next_api_changes/
  • [N/A] Release notes conform with instructions in next_whats_new/README.rst or next_api_changes/README.rst

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.
Carreau changed the title DOC: Remove space after directive name, before double-colon.. DOC: Remove space after directive name, before double-colon Jan 10, 2023

dstansby left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Choose a reason Spam Abuse Off Topic Outdated Duplicate Resolved Low Quality

If doc build passes, anyone feel free to merge

dstansby added this to the v3.7.0 milestone Jan 10, 2023
oscargus merged commit e147ff1 into matplotlib:main Jan 10, 2023
meeseeksmachine pushed a commit to meeseeksmachine/matplotlib that referenced this pull request Jan 10, 2023

Carreau commented Jan 10, 2023

Copy link
Copy Markdown
Contributor Author

❤️ 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)
QuLogic modified the milestones: v3.7.0, v3.6.3 Jan 11, 2023

QuLogic commented Jan 11, 2023

Copy link
Copy Markdown
Member

@meeseeksdev backport to v3.6.x

meeseeksmachine pushed a commit to meeseeksmachine/matplotlib that referenced this pull request Jan 11, 2023
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)
ksunden mentioned this pull request Feb 20, 2023
6 tasks
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

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants


Back | FazBrowse Home | New Git URL