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

Possible improvements to current naming scheme #51

Open
lbianchi-lbl opened this issue Jun 2, 2023 · 1 comment
Open

Possible improvements to current naming scheme #51

lbianchi-lbl opened this issue Jun 2, 2023 · 1 comment
Assignees
Labels
Priority:Normal Normal Priority Issue or PR

Comments

@lbianchi-lbl
Copy link
Contributor

lbianchi-lbl commented Jun 2, 2023

While there's no urgent need to do so, we have discussed the possibility of considering alternatives to the naming scheme (and consequently notebook discovery and processing logic) currently being used.

Unless (or until) there are concrete plans to actually change something, the purpose of this issue is to brainstorm, collect, and document the various solutions being considered and their pros/cons evaluations.

@lbianchi-lbl
Copy link
Contributor Author

To start things off: one disadvantage of the current scheme (based on the _src path stem prefix) is due to accidental "collisions" occurring if the snake_case path stem happens to contain a word that is lexically sorted somewhere between the set of suffixes being used.

In this example, the notebook having introduction_short as its path stem is sorted before the _src-suffixed version of the introduction notebook, preventing the set of related suffixed notebook files from being grouped together:

image

@ksbeattie ksbeattie added the Priority:Normal Normal Priority Issue or PR label Jun 8, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Priority:Normal Normal Priority Issue or PR
Projects
None yet
Development

No branches or pull requests

3 participants