Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Improve docs of toplevel module. #14958

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
Aug 5, 2019
Merged

Conversation

anntzer
Copy link
Contributor

@anntzer anntzer commented Aug 1, 2019

Hiding the huge RcParams.validators list, putting some sections, and
reordering some functions in a more logical order?

Before: https://matplotlib.org/devdocs/api/matplotlib_configuration_api.html
After: https://8397-7439715-gh.circle-artifacts.com/0/home/circleci/project/doc/build/html/api/matplotlib_configuration_api.html

PR Summary

PR Checklist

  • Has Pytest style unit tests
  • Code is Flake 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

Copy link
Member

@story645 story645 left a comment

Choose a reason for hiding this comment

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

I'm okay with the dictionary going away, but is it ever useful for the user to have or is that information better documented anywhere else?

@anntzer
Copy link
Contributor Author

anntzer commented Aug 1, 2019

Copy link
Member

@timhoffm timhoffm left a comment

Choose a reason for hiding this comment

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

The docs of RcParams could link https://matplotlib.org/devdocs/tutorials/introductory/customizing.html#a-sample-matplotlibrc-file.

Leaving open if you want to add this. You can self-merge with or without the change.

@story645
Copy link
Member

story645 commented Aug 4, 2019

@timhoffm & @anntzer - would a follow up PR that documents that RC file in nice organized tables make sense or not worth it?

@timhoffm
Copy link
Member

timhoffm commented Aug 5, 2019

@story645 yes, I think so. This would also be a good link target for our :rcparams: directive.

@anntzer
Copy link
Contributor Author

anntzer commented Aug 5, 2019

added the link to the tutorial.

Hiding the huge RcParams.validators list, putting some sections, and
reordering some functions in a more logical order?
@timhoffm timhoffm added this to the v3.2.0 milestone Aug 5, 2019
@timhoffm timhoffm merged commit 004e53a into matplotlib:master Aug 5, 2019
@anntzer anntzer deleted the toplevel-docs branch August 5, 2019 11:02
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.

3 participants