Skip to content

Replace "matplotlibrc" by "rcParams" in the docs where applicable. #10898

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
Apr 1, 2018

Conversation

anntzer
Copy link
Contributor

@anntzer anntzer commented Mar 27, 2018

In preparation for the possible switch to the new rcsystem.

This doesn't touch any place actually documenting the rcsystem, just
places where "the foo param in the matplotlibrc" can reasonably be
replaced by "the foo rcParam".

The examples.download and examples.directory rcParams removed from
doc/matplotlibrc have been removed in 6c5e961 (2012). The
verbose.level rcParam is deprecated, update the docs accordingly.

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

@anntzer anntzer added this to the v3.0 milestone Mar 27, 2018

These properties can also be set in the ``.matplotlib/matplotlibrc``.
Copy link
Member

Choose a reason for hiding this comment

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

either "in ..." or "in the file ..."

Copy link
Contributor Author

Choose a reason for hiding this comment

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

fixed

@@ -3369,8 +3369,7 @@ def boxplot(self, x, notch=None, sym=None, vert=None, whis=None,

"""

# If defined in matplotlibrc, apply the value from rc file
# Overridden if argument is passed
# Missing arguments default to rcParam values.
Copy link
Member

Choose a reason for hiding this comment

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

rcParams

Copy link
Contributor Author

Choose a reason for hiding this comment

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

fixed

In preparation for the possible switch to the new rcsystem.

This doesn't touch any place actually documenting the rcsystem, just
places where "the foo param in the matplotlibrc" can reasonably be
replaced by "the foo rcParam".

The `examples.download` and `examples.directory` rcParams removed from
doc/matplotlibrc have been removed in 6c5e961 (2012).  The
verbose.level rcParam is deprecated, update the docs accordingly.
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.

Conditionally on CI pass.

@jklymak jklymak merged commit 3599db9 into matplotlib:master Apr 1, 2018
@anntzer anntzer deleted the mplrc branch April 1, 2018 06:09
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