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

Clarified wording in best practices docs #7290

Merged
merged 2 commits into from
Sep 18, 2024
Merged

Clarified wording in best practices docs #7290

merged 2 commits into from
Sep 18, 2024

Conversation

jbednar
Copy link
Member

@jbednar jbednar commented Sep 17, 2024

Added additional explanation where I thought it would be helpful.

@Coderambling
Copy link
Contributor

Very useful! Especially the more verbose emphasis on the distinction between parameter as an object, and the value of a parameter.

Would be good to state the distinction that explicitly in all the docs where applicable.

Copy link
Contributor

@ahuang11 ahuang11 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for the additional clarifications!

@jbednar
Copy link
Member Author

jbednar commented Sep 17, 2024

Waiting on #7286 to fix the CI.

@Coderambling
Copy link
Contributor

Very useful additions to the best practices document.

One remark: the paragraph below inthe doc ends with:

because Viewer allows direct invocation of the class, resembling a native Panel object.

With "invocation of the class", do you mean invocation of the param.Parameterized class? Or if not, what class? Would be good to make this more explicit in the sentence.

Instead of inheriting from param.Parameterized, using pn.viewable.Viewer allows direct invocation of the class, resembling a native Panel object.
param.Parameterized is a very general class that can be used separately from Panel for working with Parameters. But if you want a Parameterized class to use with Panel, it is usually appropriate to inherit from the Panel-specific class pn.viewable.Viewer instead, because Viewer allows direct invocation of the class, resembling a native Panel object.

@philippjfr philippjfr merged commit c83c112 into main Sep 18, 2024
10 checks passed
@philippjfr philippjfr deleted the clearerbest branch September 18, 2024 20:31
@jbednar
Copy link
Member Author

jbednar commented Sep 19, 2024

With "invocation of the class", do you mean invocation of the param.Parameterized class? Or if not, what class? Would be good to make this more explicit in the sentence.

I think that's a question for @ahuang11 , who can hopefully clarify that bit of the text!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants