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

Enhance defer load docs #5112

Merged
merged 9 commits into from
Jul 2, 2023
Merged

Conversation

MarcSkovMadsen
Copy link
Collaborator

@MarcSkovMadsen MarcSkovMadsen commented Jun 14, 2023

As the title states. Builds on top of #5105 and #5107.

You can preview the document here.

Todo

@MarcSkovMadsen
Copy link
Collaborator Author

MarcSkovMadsen commented Jun 14, 2023

Assets

panel-longrunning-task-example
panel-defer-all-example
panel-defer-specific-example
panel-defer-onload-example
panel-defer-dependent-tasks-example
loading-done

@codecov
Copy link

codecov bot commented Jun 14, 2023

Codecov Report

Merging #5112 (bb45344) into main (1c006f5) will increase coverage by 0.11%.
The diff coverage is n/a.

@@            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     
Flag Coverage Δ
ui-tests 40.54% <ø> (+0.13%) ⬆️
unitexamples-tests 73.77% <ø> (-0.05%) ⬇️

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

@philippjfr
Copy link
Member

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.

MarcSkovMadsen and others added 2 commits June 24, 2023 05:48
fix spelling

Co-authored-by: Philipp Rudiger <prudiger@anaconda.com>
@MarcSkovMadsen
Copy link
Collaborator Author

MarcSkovMadsen commented Jun 24, 2023

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.

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 ?

@MarcSkovMadsen MarcSkovMadsen marked this pull request as ready for review June 24, 2023 04:27
@MarcSkovMadsen
Copy link
Collaborator Author

I simply cannot imagine how to visually convey the deferred load without gifs @philippjfr . Please help me. How would you do it?

@MarcSkovMadsen MarcSkovMadsen mentioned this pull request Jul 1, 2023
10 tasks
@philippjfr
Copy link
Member

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.

Copy link
Member

@philippjfr philippjfr left a 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


def table(data):
if data is None:
return pn.Row(loading_indicator(), "Loading data")
Copy link
Member

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.

Copy link
Collaborator Author

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.

@MarcSkovMadsen
Copy link
Collaborator Author

I do think there's at least two separate guides in here

It is actually a tutorial instead?

@philippjfr
Copy link
Member

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.

@MarcSkovMadsen
Copy link
Collaborator Author

I will start splitting this into two How-To guides. One explaining defer_load another explaining pn.state.onload. Both aiming to explain how to defer the load.

@MarcSkovMadsen
Copy link
Collaborator Author

I've now split this into two guides. Please let me know if there is more I should do @philippjfr . Thanks.

@philippjfr
Copy link
Member

Looks great!

@philippjfr philippjfr merged commit 7029343 into main Jul 2, 2023
12 of 14 checks passed
@philippjfr philippjfr deleted the enhancement/improve-defer-load-docs branch July 2, 2023 16:45
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants