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

Naming convention for notebook files #78

Open
stephane-caron opened this issue Nov 9, 2023 · 0 comments
Open

Naming convention for notebook files #78

stephane-caron opened this issue Nov 9, 2023 · 0 comments

Comments

@stephane-caron
Copy link

I followed the instructions and created the following skeleton:

├── README.md
├── conda-env.yml
├── tp1
│   └── tutorial.py
└── tutorial.ipynb

Then I run gepetuto and it said:

$ gepetuto -a generate
Python 3.11.6

(The CLI is peu bavarde, it is welcome to tell us what's going on for guidance 😉)

I looked into the code and found that the project expects the notebook to be named {id}-something.ipynb.

  • Immediate suggestion: document this requirement in the readme.
  • More long-term suggestion: we could find a better way to document dependency of notebook foo.ipynb on directory bar/, for instance parsing all [#]%load instructions.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant