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]: matplotlibrc.template does not exist anymore #25678

Closed
oscargus opened this issue Apr 13, 2023 · 10 comments · Fixed by #25727
Closed

[Doc]: matplotlibrc.template does not exist anymore #25678

oscargus opened this issue Apr 13, 2023 · 10 comments · Fixed by #25727
Labels
Documentation Good first issue Open a pull request against these issues if there are no active ones! topic: rcparams
Milestone

Comments

@oscargus
Copy link
Contributor

Documentation Link

https://matplotlib.org/stable/api/rcsetup_api.html

Problem

"Any additions or deletions to the parameter set listed here should also be propagated to the matplotlibrc.template in Matplotlib's root source directory."

matplotlibrc.template is now called matplotlibrc and located in lib/matplotlib/mpl-data/

Grepping:

lib/matplotlib/__init__.py:https://github.com/matplotlib/matplotlib/blob/%(version)s/matplotlibrc.template
lib/matplotlib/font_manager.py:            matplotlibrc.template file
lib/matplotlib/rcsetup.py:propagated to the :file:`matplotlibrc.template` in Matplotlib's root source
lib/matplotlib/rcsetup.py:# The rcParams defaults are defined in matplotlibrc.template, which gets copied
lib/matplotlib/rcsetup.py:_hardcoded_defaults = {  # Defaults not inferred from matplotlibrc.template...
lib/matplotlib/text.py:            :ref:`matplotlibrc.template file

Suggested improvement

Update all references to matplotlibrc.template, except for those in old change notes:

doc/users/prev_whats_new/changelog.rst:    matplotlibrc.template so that text will be scaled by default when changing
doc/users/prev_whats_new/changelog.rst:    commented out all default values in matplotlibrc.template Default values
doc/users/prev_whats_new/github_stats_3.1.1.rst:* :ghpull:`14409`: Backport PR #14335 on branch v3.1.x (Add explanation of animation.embed_limit to matplotlibrc.template)
doc/users/prev_whats_new/github_stats_3.1.1.rst:* :ghpull:`14335`: Add explanation of animation.embed_limit to matplotlibrc.template
doc/users/prev_whats_new/github_stats_3.2.0.rst:* :ghpull:`15108`: Fix doc build and resync matplotlibrc.template with actual defaults.
doc/users/prev_whats_new/github_stats_3.2.0.rst:* :ghpull:`14723`: Cleanup some parameter descriptions in matplotlibrc.template
doc/users/prev_whats_new/github_stats_3.2.0.rst:* :ghpull:`14709`: Try to improve the readability and styling of matplotlibrc.template file
doc/users/prev_whats_new/github_stats_3.2.0.rst:* :ghpull:`14671`: Improve readability of matplotlibrc.template
doc/users/prev_whats_new/github_stats_3.3.0.rst:* :ghpull:`15029`: Get default params from matplotlibrc.template.
doc/users/prev_whats_new/github_stats_3.3.0.rst:* :ghpull:`16523`: Reorder mathtext rcparams in matplotlibrc template.
doc/users/prev_whats_new/github_stats_3.3.0.rst:* :ghpull:`15023`: Simplify formatting of matplotlibrc.template.
doc/users/prev_whats_new/github_stats_3.5.0.rst:* :ghpull:`19603`: Remove matplotlibrc.template.
doc/users/prev_whats_new/github_stats_3.5.0.rst:* :ghpull:`19718`: Small style fixes to matplotlibrc.template.

(The above should BE KEPT.)

@Higgs32584
Copy link
Contributor

This might be a good first issue!

@rcomer rcomer added topic: rcparams Good first issue Open a pull request against these issues if there are no active ones! labels Apr 14, 2023
@tacaswell tacaswell added this to the future releases milestone Apr 14, 2023
@farukalamai
Copy link

@oscargus hey, I am new as a contributor. How can assign myself to this issue?

@rcomer
Copy link
Member

rcomer commented Apr 15, 2023

@farukalampro you are welcome to submit a pull request for any issue, but we do not assign them. Please see our contributors’ guide:
https://matplotlib.org/devdocs/devel/contributing.html

@rcomer
Copy link
Member

rcomer commented Apr 15, 2023

The guide I linked above describes the best place to ask for help. I am not going to email you, sorry.

@farukalamai
Copy link

@rcomer thanks dear

@Shashwatpandey4
Copy link

I've the required changes, and even after 'add .' and 'commit', they are still not getting committed
i've followed :
https://matplotlib.org/devdocs/devel/contributing.html
https://matplotlib.org/devdocs/devel/development_setup.html#installing-for-devs
also ran pre-commit hooks before committing.

@rcomer @oscargus

image

@ksunden
Copy link
Member

ksunden commented Apr 17, 2023

@Shashwatpandey4 it looks like you have your entire virtual environment added in git, which is why precommit is flagging codespell in our dependencies and preventing the commit from completing

@ksunden
Copy link
Member

ksunden commented Apr 17, 2023

@Shashwatpandey4 you still have your environment added, you'll need to git reset venv to remove them from your git add (.gitignore only affects future adds, not past adds)

I would generally recommend either setting up your venvs outside of the git repo or changing your personal global gitignore to avoid editing project .gitignores for your workflow:

https://docs.github.com/en/get-started/getting-started-with-git/ignoring-files#configuring-ignored-files-for-all-repositories-on-your-computer

@Higgs32584
Copy link
Contributor

you can go to pull request to open a new one, and then make sure to reference the issue number so that it is linked @Shashwatpandey4

@rcomer rcomer linked a pull request Apr 18, 2023 that will close this issue
@snorfyang
Copy link
Contributor

snorfyang commented Apr 20, 2023

Hi, does this issue still open? If so, I'll handle this problem. @rcomer @ksunden

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Documentation Good first issue Open a pull request against these issues if there are no active ones! topic: rcparams
Projects
None yet
Development

Successfully merging a pull request may close this issue.

9 participants