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

Split examples into scripts & notebooks subfolders #546

Open
schuenke opened this issue Nov 20, 2024 · 4 comments · May be fixed by #537
Open

Split examples into scripts & notebooks subfolders #546

schuenke opened this issue Nov 20, 2024 · 4 comments · May be fixed by #537

Comments

@schuenke
Copy link
Collaborator

The number of example scripts/notebooks increased quite a lot already and will probably increase further in the future. FI was wondering if it might be a clearer structure if we split the examples folder into a scripts and a notebooks subfolder. Furthermore, it happened to me several times that I clicked on a notebook when I wanted to open a script and vise versa.

The new structure could look like this:

├── ...
├── examples
│   ├── notebooks
│   │   └── *.ipynb files
│   ├── scripts
│   │   └── *.py files
│   └── ruff.toml
└── ...

Or we could leave the scripts in the examples folder and only move the *.ipynb files into a notebooks subfolder:

├── ...
├── examples
│   ├── notebooks
│   │   └── *.ipynb files
│   ├── *.py files
│   └── ruff.toml
└── ...

Any opinions?

@fzimmermann89
Copy link
Member

fzimmermann89 commented Nov 20, 2024

+1 to splitting,
I think I would slightly prefer option 1

@schuenke
Copy link
Collaborator Author

+1 to splitting, I think I would slightly prefer option .

Maybe it's just me, but I don't really understand which option you prefer 😨

@fzimmermann89
Copy link
Member

Not sure how that happened.😅

Separate notebooks and scripts folder in examples.

@lrlunin
Copy link
Collaborator

lrlunin commented Nov 20, 2024

Should I do it in #537 then?

UPD: done in 865347a

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

Successfully merging a pull request may close this issue.

3 participants