Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Merged
merged 1 commit into from Jan 10, 2023

Conversation

Carreau
Copy link
Contributor

@Carreau Carreau commented Jan 10, 2023

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 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
Copy link
Member

@dstansby dstansby left a comment

Choose a reason for hiding this comment

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

If doc build passes, anyone feel free to merge

@dstansby dstansby added this to the v3.7.0 milestone Jan 10, 2023
@oscargus 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
Copy link
Contributor Author

Carreau commented Jan 10, 2023

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

QuLogic commented Jan 11, 2023

@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 ksunden mentioned this pull request Feb 20, 2023
6 tasks
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.

None yet

4 participants