-
-
Notifications
You must be signed in to change notification settings - Fork 531
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
Enhance defer load docs #5112
Enhance defer load docs #5112
Conversation
Codecov Report
@@ Coverage Diff @@
## main #5112 +/- ##
==========================================
+ Coverage 83.71% 83.82% +0.11%
==========================================
Files 274 274
Lines 39271 39594 +323
==========================================
+ Hits 32874 33189 +315
- Misses 6397 6405 +8
Flags with carried forward coverage won't be shown. Click here to find out more. see 44 files with indirect coverage changes 📣 We’re building smart automated test selection to slash your CI/CD build times. Learn more |
I think there is a strong over-reliance on gifs. One or two in a how-to guide seems reasonable to me, 5 seems like way too much. |
fix spelling Co-authored-by: Philipp Rudiger <[email protected]>
I've read through the guide and tried to think how I can show the user the waiting time or lack of the same without videos. I've done this several times. I cannot figure this out. I need help. How would you do it @philippjfr ? |
I simply cannot imagine how to visually convey the deferred load without gifs @philippjfr . Please help me. How would you do it? |
I think it's actually okay but I do wonder if this is once again a matter of putting too much into one how to guide. How-to guides are meant to be short and to the point rather than collections of a bunch of related but slightly different approaches, i.e. I definitely don't think generators and onload are part of the same 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.
I do think there's at least two separate guides in here
doc/how_to/callbacks/load.md
Outdated
|
||
def table(data): | ||
if data is None: | ||
return pn.Row(loading_indicator(), "Loading data") |
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.
Should be able to simply give the loading indicator a name now.
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.
At least when #5194 has been committed to main
.
It is actually a tutorial instead? |
We do need to define what a tutorial looks like but I don't think this is it. Just like other how to guides this material is very task oriented, i.e. it aims to get the reader how to achieve something very specific while a tutorial is much more learning oriented and gets the user to build something larger in a number of smaller steps. |
I will start splitting this into two |
I've now split this into two guides. Please let me know if there is more I should do @philippjfr . Thanks. |
Looks great! |
As the title states. Builds on top of #5105 and #5107.
You can preview the document here.
Todo