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

Allow for non-numbered episodes in checks #587

Open
jhlegarreta opened this issue Apr 22, 2021 · 0 comments
Open

Allow for non-numbered episodes in checks #587

jhlegarreta opened this issue Apr 22, 2021 · 0 comments
Assignees

Comments

@jhlegarreta
Copy link

jhlegarreta commented Apr 22, 2021

The episode filename pattern regex expects these to start with a number:

P_EPISODE_FILENAME = re.compile(r'(\d\d)-[-\w]+.md$')

However, in
https://github.com/carpentries-incubator/SDC-BIDS-dMRI

We decided to remove the numbers and use the episode order feature (https://carpentries.github.io/lesson-example/03-organization/) because we wanted to avoid renaming all subsequent files in case a new episode is added and fits somewhere in the middle following the teaching logic.

Done in here:
carpentries-incubator/SDC-BIDS-dMRI#67

Partially related to the above is that we have nested episodes:
carpentries-incubator/SDC-BIDS-dMRI#47

And numbered file naming is somewhat limited when using a nested filename convention.

Hence, we now find ourselves with style warnings:
https://github.com/carpentries-incubator/SDC-BIDS-dMRI/runs/2401702149?check_suite_focus=true#step:16:9

because we do not have numbered filenames.

I know this might not be easy, but could the filename check be skipped if the repository uses the episode order feature in the _config.yml file?

This might need to be accompanied by changes (or further explanations) in the Locations and Names section:
https://carpentries.github.io/lesson-example/04-formatting/index.html

Note: I have checked locally that using underscores (vs. using dashes) in the filenames does not raise the warning (at least past the number of the filename). We opted for using underscores influenced by Python.

Thanks.

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

2 participants