Improve Checkbox, Toggle and Switch docs to clearly indicate they are all interchangeable and add links #7737
Comments
Coderambling
added a commit
to Coderambling/panel
that referenced
this issue
Feb 26, 2025
…ngeable with Checbox. Textual improvements to clarify all 3 widgets are interchangeable, and adds links to the 2 docs for the other widgets that are interchangeable. See holoviz#7737 No entirely sure if the added links are structured correctly, so that they will be converted to correct links when the webpage is generated from the Notebook. See issue holoviz#7737 for request for further explanation on this.
philippjfr
pushed a commit
that referenced
this issue
Mar 5, 2025
…ngeable with Checbox. (#7738) Textual improvements to clarify all 3 widgets are interchangeable, and adds links to the 2 docs for the other widgets that are interchangeable. See #7737 No entirely sure if the added links are structured correctly, so that they will be converted to correct links when the webpage is generated from the Notebook. See issue #7737 for request for further explanation on this.
Coderambling
added a commit
to Coderambling/panel
that referenced
this issue
Mar 6, 2025
…nterchangeable Updated doc with the same information as the Checkbox doc. See holoviz#7738 and holoviz#7737
Coderambling
added a commit
to Coderambling/panel
that referenced
this issue
Mar 6, 2025
…nterchangeable Updated doc with the same information as the Checkbox doc. See holoviz#7738 holoviz#7760 and holoviz#7737
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Textual improvements to mor clearly clarify Checbox, Toggle and Switch are interchangeable. Right now the in the docs of each component it is mentioned for 1 of the other components, instead of both.
Adds links in the doc to the 2 other component docs.
Not entirely sure abou the correct link syntax that should be followed in an .ipnyb doc, so doing this one first. If that works out ok, I will update the other 2 docs accordingly.
I have found this PR related to that. holoviz-dev/nbsite#315 . It introduces an URL parser and some checks.
Is ther a guide to this? It is not clear to me what the correct syntax is for entering links in doc Notebooks to other doc Notebooks, so they show up correctly after they have been converted to website pages.
Is there any guide? If Noteboo02 is in the same dir as Notebook01, the link in Notebook01 to Notebook02 should be [Some text](Notebook02.ipynb}? Or should it be prepended with ./ or / ?
If, for example Notebook03 is 2 dirs up, the link should be (../../Notebook03.ipynb) ?
Also, what about referring to a specific section of a Notebook? Will this work? (../../Notebook03.ipynb#a_section) ?
This is issue is also a partial follow-up on remarks in this PR: #7729
The text was updated successfully, but these errors were encountered: