Skip to content

Commit

Permalink
Add cache location hint to persist option documentation (#200)
Browse files Browse the repository at this point in the history
  • Loading branch information
maweigert committed Mar 25, 2021
1 parent b1a0fa9 commit f0d25cd
Showing 1 changed file with 3 additions and 2 deletions.
5 changes: 3 additions & 2 deletions magicgui/_magicgui.py
Original file line number Diff line number Diff line change
Expand Up @@ -58,8 +58,9 @@ def magicgui(
A backend to use, by default ``None`` (use the default backend.)
persist : bool, optional
If `True`, when parameter values change in the widget, they will be stored to
disk (in `~/.config/magicgui/cache`) and restored when the widget is loaded
again with ``persist = True``. By default False.
disk and restored when the widget is loaded again with ``persist = True``.
Call ``magicgui._util.user_cache_dir()`` to get the default cache location.
By default False.
**param_options : dict of dict
Any additional keyword arguments will be used as parameter-specific options.
Expand Down

0 comments on commit f0d25cd

Please sign in to comment.