Skip to content

[DOC] Document usage of all rcparams. #25837

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

Draft
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

chahak13
Copy link
Contributor

@chahak13 chahak13 commented May 9, 2023

PR summary

PR checklist

@oscargus
Copy link
Member

oscargus commented May 23, 2023

I think this is really cool! Maybe you can filter out lines related to tests, rcsetup.py, and styles to make it easier to see what it should/could look like?

Also, one should maybe swap the line number and "function" columns? Because of the fixed-width HTML page, one cannot really see the "function" quite often (also the explanation may come before the line number).

(I realize that this is a proof-of-concept, but thought it is worth trying to move it towards what it may be like. From that perspective, I may just go Title Case for the titles rather than ALL CAPS. Even if this may not be the "official" rcParams documentation, I think it is a really good reference list for development etc., so it would be nice to have it somewhere, possibly even dynamically generated as you may have a script that does this?)

@story645 story645 linked an issue May 23, 2023 that may be closed by this pull request
@chahak13
Copy link
Contributor Author

Thanks, Oscar! Yes, I agree on removing the test/setup/style entries. I have a script that generates the table and I'm then filling out the explanation. I'll make the changes you mentioned once I've gone through writing some description about all of them. Definitely a proof-of-concept but I feel something like this should be there for 1. Developers to know what all gets touched by rcparams and 2. if read by some user, then they know what all they are changing when the change a particular value. I should get back to this soon.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[Doc]: Documentation of rc parameters could be improved
2 participants