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

Add cache location hint to persist option documentation #200

Merged
merged 1 commit into from
Mar 25, 2021

Conversation

maweigert
Copy link
Contributor

@maweigert maweigert commented Mar 24, 2021

Small change in the doc of the persist option (the earlier given cache location is different on OSX for example)

@tlambert03
Copy link
Member

thanks again. Since this (and pretty much all of the options on @magicgui) are just parameters for magicgui.widgets.FunctionGui. We should also add it to the docs there too. Also, I don't love adding a private module.parameter to the docstring like that, so maybe we should make _util.py public? Alternatively, fyi, you can get the specific cache path of each generated widget at widget._dump_path. Not sure if you want to mention that... we could make that public (and possible change the name to cache_path). Thoughts?

@maweigert
Copy link
Contributor Author

Sure, maybe even add that cache location may vary is already enough (instead of changing visibility of a whole module). I was just a bit tripped up by the current doc and that might be the case for others to.

@tlambert03
Copy link
Member

I was just a bit tripped up by the current doc and that might be the case for others to.

yeah, def... that was outdated. much appreciated. OK, let's just use this as is for now and I may extend it later. thanks again!

@tlambert03 tlambert03 merged commit f0d25cd into pyapp-kit:master Mar 25, 2021
@tlambert03 tlambert03 added the documentation Improvements or additions to documentation label Apr 3, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants