-
Notifications
You must be signed in to change notification settings - Fork 7
User guide examples for bokeh server and django #60
Conversation
…parambokeh in django user guide.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looks good to me; it's hard to say without seeing it presented as an example. In the https://github.com/pyviz/pyviz/blob/master/notebooks/A2_Dashboard_Workflow.ipynb notebook, you can see that I handled the partial-app issue by introducing each bit of code on its own in the notebook, showing how each bit works, and only then showed the separate full app by dumping the file onscreen. The code in the snippets and the app then drift our of sync over time, of course, but at least the snippets let people understand it bit by bit and try it themselves. As you wish!
doc/user_guide/index.rst
Outdated
* `ViewParameters <View_Parameters.html>`_ | ||
Dynamically control some visual output. | ||
|
||
* `Usage in Bokeh Apps <Bokeh_App.html>`_ | ||
How to use ParamBokeh in a Bokeh server application. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Not sure "Usage in" adds anything here or below.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Agreed
Maybe it's clearer if you look at the source only notebook? This approach does introduce the example bit by bit. It's just in desperation to avoid duplicating the code (which will inevitably go out of date as you say...), I have resorted to a hack (which would need to be hidden/imported from elsewhere). Combined with the screenshot in the original comment above, which shows how it looks when the notebook is run (the code's there and can be copy/pasted etc), I think that should let you see the pros and cons. Probably I vote for just doing what you did, and copy/pasting the code into the notebook. |
…mple code into notebooks.
If the website builds ok, I will merge. There are definitely improvements we could make to this documentation, but it's ready to receive user feedback, plus some improvement will come separately from reviewing the entire documentation after #61 is merged and when we switch to the new (still upcoming) release of nbsite (because the website editing process should then be easier, encouraging us to make the improvements). |
Not yet ready to review, except for two bits I'd like feedback on already:
I could instead just copy/paste bits. Or I could not refer to the example specifically at all; just describe how to use parambokeh in bokeh server, and then at the end say "for a concrete example, see ...". Or maybe there's something better I could do?