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.

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

Jump to bottom

Align Param docstring #6989

Merged
merged 2 commits into from
Jul 16, 2024
Merged

Align Param docstring #6989

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
c07df7f
add misssing docstring
MarcSkovMadsen Jul 16, 2024
aaabd8f
improve explanation
MarcSkovMadsen Jul 16, 2024
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
21 changes: 19 additions & 2 deletions panel/param.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -129,8 +129,25 @@ def set_values(*parameterizeds, **param_values):

class Param(Pane):
"""
Param panes render a Parameterized class to a set of widgets which
are linked to the parameter values on the class.
Param panes render a Parameterized class into a set of interactive widgets
that are dynamically linked to the parameter values of the class.

Reference: https://panel.holoviz.org/reference/panes/Param.html

Example:

>>> import param
>>> import panel as pn
>>> pn.extension()

>>> class App(param.Parameterized):
>>> some_text = param.String(default="Hello")
>>> some_float = param.Number(default=1, bounds=(0, 10), step=0.1)
>>> some_boolean = param.Boolean(default=True)

>>> app = App()

>>> pn.Param(app, parameters=["some_text", "some_float"], show_name=False).servable()
"""

display_threshold = param.Number(default=0, precedence=-10, doc="""
Expand Down
Loading