Improve wording and consistency in installation documentation#8535
Closed
tarajyothi wants to merge 2 commits intoholoviz:mainfrom
Closed
Improve wording and consistency in installation documentation#8535tarajyothi wants to merge 2 commits intoholoviz:mainfrom
tarajyothi wants to merge 2 commits intoholoviz:mainfrom
Conversation
This PR improves the clarity and consistency of the FAQ documentation by refining wording and making explanations more precise. These changes enhance readability and provide a better experience for users.
Updated wording for clarity and consistency in installation instructions
philippjfr
reviewed
Mar 31, 2026
|
|
||
| :::{tip} | ||
| We recommend also installing [`watchfiles`](https://watchfiles.helpmanual.io) while developing. This will provide a significantly better experience when using Panel's autoreload features when activating `--dev` mode. It's not needed for production. | ||
| We recommend also installing [`watchfiles`](https://watchfiles.helpmanual.io) while developing.This provides a significantly better experience when using Panel's autoreload features in `--dev` mode.It's not needed for production. |
Member
There was a problem hiding this comment.
Suggested change
| We recommend also installing [`watchfiles`](https://watchfiles.helpmanual.io) while developing.This provides a significantly better experience when using Panel's autoreload features in `--dev` mode.It's not needed for production. | |
| We recommend also installing [`watchfiles`](https://watchfiles.helpmanual.io) while developing.This provides a significantly better experience when using Panel's autoreload features in `--dev` mode. It's not needed for production. |
philippjfr
reviewed
Mar 31, 2026
| **Q: Does it matter which plotting library I use with Panel?** | ||
|
|
||
| **A:** Yes and no! Just about `any Python library <https://pyviz.org/tools.html>`__ will work with Panel. That said, only certain libraries will provide deeply interactive objects in a web browser, such as Bokeh and Plotly. If you want to tie custom actions to individual sub-elements of such a plot, you should use a library with extensive JavaScript support. Otherwise, just use any supported library that you prefer! | ||
| **A:** Yes and no! `Most Python libraries <https://pyviz.org/tools.html>`__ can be used with Panel.That said, only certain libraries will provide deeply interactive objects in a web browser, such as Bokeh and Plotly. If you want to tie custom actions to individual sub-elements of such a plot, you should use a library with extensive JavaScript support. Otherwise, just use any supported library that you prefer! |
Member
There was a problem hiding this comment.
Suggested change
| **A:** Yes and no! `Most Python libraries <https://pyviz.org/tools.html>`__ can be used with Panel.That said, only certain libraries will provide deeply interactive objects in a web browser, such as Bokeh and Plotly. If you want to tie custom actions to individual sub-elements of such a plot, you should use a library with extensive JavaScript support. Otherwise, just use any supported library that you prefer! | |
| **A:** Yes and no! `Most Python libraries <https://pyviz.org/tools.html>`__ can be used with Panel. That said, only certain libraries will provide deeply interactive objects in a web browser, such as Bokeh and Plotly. If you want to tie custom actions to individual sub-elements of such a plot, you should use a library with extensive JavaScript support. Otherwise, just use any supported library that you prefer! |
philippjfr
reviewed
Apr 8, 2026
Member
philippjfr
left a comment
philippjfr
left a comment
There was a problem hiding this comment.
While some of wording is indeed improved the PR as a whole also introduces undesired changes and since I haven't heard back I will close.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
This PR improves wording and consistency in the installation documentation by refining terminology and simplifying sentences.
These changes enhance clarity and readability for users.