Add jupyter notebook formatting to CI
Open
Nobody has claimed this yet.
enhancement
stale-notified
- Dominant language
- C++
- Stars
- 1.1k
- Forks
- 456
- Avg merge
- 1d 22h
- Merged PRs (30d)
- 165
Description
Required prerequisites
- Search the issue tracker to check if your feature has already been mentioned or rejected in other issues.
Describe the feature
We currently use yapf to format relevant .py files. With the addition of .ipynb files to our examples, we should use a tool such as nbqa (https://github.com/nbQA-dev/nbQA) to consistently format our notebooks. The command update is very simple
nbqa yapf --... typical yapf args ...
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by locating the CI command that currently runs yapf on relevant .py files and review the existing yapf arguments. Update the formatting check to cover .ipynb examples through nbqa, then verify that the CI formatting step handles notebooks consistently with the existing Python files.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- jupyter-notebook, python
- Domain
- ci-cd, tooling
- Issue type
- Feature
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100