Critical Bugfix: Run nbdev_clean to make sure nbs/index.ipynb conform to the standard #19
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
deephbz
changed the title
deephbz
force-pushed
the
bugfix/nbdev-clean
branch
from
01cf529 to
116e976
Compare
deephbz
force-pushed
the
bugfix/nbdev-clean
branch
from
116e976 to
ad67574
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Issue this PR solves
nbdev-ci Github Action will do a
nbdev_cleanand checkgit statusto make sure all notebooks conform to the nbdev_clean standard. However, the existingnbs/index.ipynbdoes not satisfy this standard. This causesnbdev-ciworkflow to fail, which in turn makes all users following the nbdev tutorial fail and get confusing at the step.I love the literate + exploratory programming principle and would love to push it further. Therefore, such issue blocking new users' onboarding should be fixed with priority.
Minimal Reproducible Example (b4 and after fix)
Before Fix
Simply follow the tutorial and the first Github Action run will fail: At log line 250 nbdev_clean runs and at line 254 git status check fails.
After Fix
This Github Action is run on a PRed branch of the same repo. The PR change is the same as what's proposed in this PR.