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

nbdev_clean documentation partly wrong #1480

Open
ritagonmar opened this issue Dec 19, 2024 · 0 comments
Open

nbdev_clean documentation partly wrong #1480

ritagonmar opened this issue Dec 19, 2024 · 0 comments
Labels
bug Something isn't working

Comments

@ritagonmar
Copy link

I was trying out nbdev_clean and I realized the documentation is not completely right, which caused me some confusion.
In the documentation (https://nbdev.fast.ai/api/clean.html#nbdev_clean) it says:

fname str None A notebook name or glob to clean

but this is not true, it accepts a single notebook name or a path, but not a glob (see detailed below). Maybe this should be changed to avoid confusion, cause it took me a while to understand what works and what doesn't, and I only figured with the help of old issues.

what works:

  • one single file (e.g. nbdev_clean --fname nb1.ipynb)
  • a path (e.g. nbdev_clean --fname ./)

what does not work:

  • passing several files (e.g. nbdev_clean --fname nb1.ipynb nb2.ipynb)
  • a glob (e.g. nbdev_clean --fname *.ipynb)
  • a path with a glob (e.g. nbdev_clean --fname ./*.ipynb)

Very cool library and features otherwise!

@ritagonmar ritagonmar added the bug Something isn't working label Dec 19, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working
Projects
None yet
Development

No branches or pull requests

1 participant