search

fastai / nbdev

Create delightful software with Jupyter Notebooks
https://nbdev.fast.ai/
Apache License 2.0
4.9k stars 487 forks source link

fixes #1364 #1376

Closed deven367 closed 11 months ago

deven367 commented 11 months ago

This PR adds a minor docstring for nbdev_readme. cc @jph00

review-notebook-app[bot] commented 11 months ago

Check out this pull request on  ReviewNB

See visual diffs & provide feedback on Jupyter Notebooks.

Powered by ReviewNB

hugetim commented 11 months ago

The proposed docstring is not accurate in the case that the readme_nb config option is set to something other than 'index.ipynb'. How about just: "Create README.md" Or else "Create README.md from readme_nb (index.ipynb by default)"?

jph00 commented 11 months ago

I like : Create README.md from readme_nb (index.ipynb by default)

deven367 commented 11 months ago

Thanks @hugetim, I've revised the docstring.

hugetim commented 11 months ago

Oops, it looks like the notebook metadata needs cleaning up (which nbdev_prepare or the git hooks should take care of).

jph00 commented 11 months ago

Thanks! :D

jph00 commented 11 months ago

Thanks :D