search

xgi-org / xgi

CompleX Group Interactions (XGI) is a Python package for higher-order networks.
https://xgi.readthedocs.io
Other
172 stars 27 forks source link

Missing `focus tutorials` in API #475

Closed thomasrobiglio closed 9 months ago

review-notebook-app[bot] commented 9 months ago

Check out this pull request on  ReviewNB

See visual diffs & provide feedback on Jupyter Notebooks.

Powered by ReviewNB

codecov[bot] commented 9 months ago

Codecov Report

All modified lines are covered by tests :white_check_mark:

Comparison is base (1b8df54) 91.90% compared to head (e444907) 91.90%.

Additional details and impacted files ```diff @@ Coverage Diff @@ ## main #475 +/- ## ======================================= Coverage 91.90% 91.90% ======================================= Files 60 60 Lines 4375 4375 ======================================= Hits 4021 4021 Misses 354 354 ```

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.

nwlandry commented 9 months ago

Thanks @thomasrobiglio! Looks great! Two quick question before you merge: (1) can we remove the top-level tutorials folder now? (2) can we get rid of the quickstart notebook? Thanks for all the work on this!

nwlandry commented 9 months ago

Oops! I was looking at the wrong branch! Disregard (1).

thomasrobiglio commented 9 months ago

Yes, we can remove the quickstart tuto. If we don't have time constraints for a new release I'd like to take 2-3 more days to check for imprecisions before merging.

nwlandry commented 9 months ago

Sounds great! I'll approve it and you can merge it when you think it's ready.

maximelucas commented 9 months ago

Nice! I added another In Depth tuto in #456 but somehow I cannot see in main now. Could you add it? https://github.com/xgi-org/xgi/blob/4e513734dfa4a22bc3095fe524398b8ae7a8d6cd/docs/source/api/tutorials/In%20Depth%202%20-%20Drawing%20hyperedges.ipynb

thomasrobiglio commented 9 months ago

@maximelucas will do tomorrow. To see it in the API you should also put the reference in the corresponding .rst file (https://github.com/xgi-org/xgi/blob/main/docs/source/api/tutorials/in_depth.rst#in-depth-tutorials in this case).

Idk if there is an automated way to have all the .ipynb files displayed but the way we are doing it now has some upsides e.g. we can choose the order in which tutos are displayed and create the different categories.

thomasrobiglio commented 9 months ago

I will open a new PR, I messed up something locally.