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

Ordering of package notebooks #90

Open
sjsrey opened this issue Mar 28, 2020 · 3 comments
Open

Ordering of package notebooks #90

sjsrey opened this issue Mar 28, 2020 · 3 comments
Labels
enhancement something necessary to improve the quality of instruction.

Comments

@sjsrey
Copy link
Member

sjsrey commented Mar 28, 2020

Currently the notebooks within a package are ordered alphabetically. For some packages this breaks the logical flow (pointpats for example).

One solution to this might be to have a README.md in the package notebooks directory that lists the specific order by which the notebooks should be visited by an interested user. Alternatively, maybe a yaml file in that directory could serve the same purpose. Either way, the notebooks project would consume these files to set the ordering of the notebooks.

@sjsrey sjsrey added the enhancement something necessary to improve the quality of instruction. label Mar 28, 2020
@darribas
Copy link
Member

darribas commented Apr 8, 2020

Thanks, good point! Another idea so it's all automatable would be to agree to have notebooks "numbered" on the notebooks folder of each package (e.g. 01_read_data.ipynb, 02_advanced_analysis.ipynb).

@sjsrey
Copy link
Member Author

sjsrey commented Apr 8, 2020

The numbering approach is a good way to go (imho).

@sjsrey
Copy link
Member Author

sjsrey commented May 17, 2020

Thanks, good point! Another idea so it's all automatable would be to agree to have notebooks "numbered" on the notebooks folder of each package (e.g. 01_read_data.ipynb, 02_advanced_analysis.ipynb).

For the notebook project, is there a limit on the number of notebooks per project?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement something necessary to improve the quality of instruction.
Projects
None yet
Development

No branches or pull requests

2 participants