Skip to content

Dedent docs in contributing.rst bullet/numbered lists. #10108

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

Merged
merged 1 commit into from
Dec 27, 2017

Conversation

anntzer
Copy link
Contributor

@anntzer anntzer commented Dec 27, 2017

A lot of bullet/numbered lists in contributing.rst are overindented,
causing them to be displayed with too much indentation in the rendered
rst. Compare e.g.

https://matplotlib.org/devdocs/devel/documenting_mpl.html#keyword-arguments
(correct indentation of "1. single point configuration etc.")

and

https://matplotlib.org/devdocs/devel/contributing.html#submitting-a-bug-report
(extra indentation of "1. A short, top-level summary etc.")

This PR dedents them.

Also closes #9200.

PR Summary

PR Checklist

  • Has Pytest style unit tests
  • Code is PEP 8 compliant
  • New features are documented, with examples if plot related
  • Documentation is sphinx and numpydoc compliant
  • Added an entry to doc/users/next_whats_new/ if major new feature (follow instructions in README.rst there)
  • Documented in doc/api/api_changes.rst if API changed in a backward-incompatible way

A lot of bullet/numbered lists in contributing.rst are overindented,
causing them to be displayed with too much indentation in the rendered
rst.  Compare e.g.

https://matplotlib.org/devdocs/devel/documenting_mpl.html#keyword-arguments
(correct indentation of "1. single point configuration etc.")

and

https://matplotlib.org/devdocs/devel/contributing.html#submitting-a-bug-report
(extra indentation of "1. A short, top-level summary etc.")
@anntzer anntzer force-pushed the dedent-contributing branch from 246bc6e to 9878653 Compare December 27, 2017 02:05
@tacaswell tacaswell added this to the v2.1.1-doc milestone Dec 27, 2017
@tacaswell tacaswell merged commit af2dd7d into matplotlib:master Dec 27, 2017
@anntzer anntzer deleted the dedent-contributing branch December 27, 2017 02:51
QuLogic added a commit that referenced this pull request Dec 27, 2017
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.

Documentation: File doc/users/whats_new/README does not exist
2 participants