Skip to content

Added text to script_repr docstring to mention existence of script_repr_suppress_defaults #1160

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.

Sign up for GitHub

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

Closed
Coderambling wants to merge 1 commit into from
Closed

Added text to script_repr docstring to mention existence of script_repr_suppress_defaults #1160

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 9 additions & 1 deletion param/parameterized.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5172,6 +5172,15 @@ def script_repr(
configuration. It captures only the state of the object's parameters, not
its internal (non-parameter) attributes.

By default, script_repr prints only parameter values that have changed from
their defaults; for the complete set of parameter values, including
all defaults, first run:

param.parameterized.script_repr_suppress_defaults=False

For more details on this, see:
https://param.holoviz.org/en/docs/latest/user_guide/Serialization_and_Persistence.html#script-repr-limitations-and-workarounds

Parameters
----------
val : Parameterized
Expand Down Expand Up @@ -5215,7 +5224,6 @@ def script_repr(
References
----------
See https://param.holoviz.org/user_guide/Serialization_and_Persistence.html#script-repr.

Examples
--------
Create a Python script representation of a Parameterized object:
Expand Down
Loading