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

Document options for set_option() #914

Open
machow opened this issue Feb 12, 2025 · 1 comment · May be fixed by #916
Open

Document options for set_option() #914

machow opened this issue Feb 12, 2025 · 1 comment · May be fixed by #916

Comments

@machow
Copy link
Contributor

machow commented Feb 12, 2025

Looking at the docstrings and reference pages, I wasn't sure what options set_option() and get_option() support. In searching for them I followed this path:

  • Look at set_option() docstring
  • Look up set_option() on reference index, and click into it
  • Look up get_option()
  • Read plotnine.options source code, notice options are documented on this module
  • Open this issue
  • Look back at Reference index and notice the Options section lists out each plotnine.options piece

I wonder if two pieces might help shorten this journey:

  1. mention on set_option() and get_option() that the documentation lives at plotnine.options.
  2. mention in the Options section of the Reference index that the items are from plotnine.options

I think (2) is similar to what the Datasets section does in the reference, which seems to work well!

@has2k1
Copy link
Owner

has2k1 commented Feb 12, 2025

1. mention on set_option() and get_option() that the documentation lives at plotnine.options

I agree.

2. mention in the Options section of the Reference index that the items are from plotnine.options

I'm not so happy that the options are global variables and mentioning plotnine.options makes it more explicit. I think the documentation should emphasise interacting with the options through get_option and set_option functions.

Maybe in the reference index we can further split the section into two tables; the options and then get/set functions.

has2k1 added a commit that referenced this issue Feb 20, 2025
@has2k1 has2k1 linked a pull request Feb 20, 2025 that will close this issue
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants