`nbdev_clean` documentation partly wrong
还没有人认领这个 Issue。
评估
- 难度
- 1/5
- 预计耗时
- 1 小时以内
- 新手友好度
- 35/100
- Issue 类型
- 文档
- 描述清晰度
- 描述清楚
- 活跃度
- 停滞
- 技术栈
- jupyter-notebook, python
调研方向
从 nbdev_clean 的 API 文档链接条目开始，将 fname 的描述与 issue 中列出的命令行为进行比较。更新文档，以区分单个 notebook 名称或路径与不支持的多文件和 glob 参数，然后验证文档中的示例。
由索引模型根据 Issue 内容生成。
描述
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!
- 主要语言
- Jupyter Notebook
- 星标
- 5.3k
- 派生
- 517
- 平均合并
- 1 分钟
- 30 天内合并 PR
- 3
环境准备
- 没有 Dockerfile 或 Docker Compose 文件
- 没有 Pull Request 模板
- 阅读贡献指南
从这里开始
- 先读完整个 Issue，再读项目的贡献指南。
- 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
- Fork 仓库，在一个分支上完成修改。
- 提交 Pull Request，并在描述里引用这个 Issue 编号。
AnswerDotAI/nbdev 的其他 Issue
-
Bug Report: `nbdev` Parser `IndexError` on `@patch_to` with Keyword Arguments可能已有人在做 @ruchi-mish90 于 86 天前认领。 未关闭bug
难度 2/5 1-3 小时 新手友好度 78/100
AnswerDotAI/nbdev#1596 · 1 条评论 ·
-
难度 5/5 一周以上 新手友好度 25/100
AnswerDotAI/nbdev#1587 ·
-
Interested in Windows support?可能已有人在做 @mrexodia 于 10 天前认领。 未关闭
难度 4/5 3-5 天 新手友好度 35/100
AnswerDotAI/nbdev#1584 · 1 条评论 ·
-
难度 3/5 1-2 天 新手友好度 35/100
AnswerDotAI/nbdev#1583 · 1 条评论 · 1 个 reaction ·
-
bug
难度 3/5 1-2 天 新手友好度 52/100
AnswerDotAI/nbdev#1581 ·
查看 AnswerDotAI/nbdev 的全部 Issue
相似的 Issue
-
难度 1/5 1 小时以内 新手友好度 85/100
-
Table: Space fires onActivate in single-selection mode — the reference doc and the JSDoc disagree未关闭
难度 2/5 1-3 小时 新手友好度 68/100
sidorares/react-x11-components#764 ·
维护者通常 1 天内回复
-
难度 1/5 1 小时以内 新手友好度 71/100
t4t5/omdrop-owl#14 ·
维护者通常 1 天内回复
-
documentation
难度 1/5 1 小时以内 新手友好度 91/100
githubnext/gh-aw-workshop#4458 ·
维护者通常 1 天内回复
-
bug:new
难度 1/5 1 小时以内 新手友好度 84/100
callstackincubator/simlock#451 ·
维护者通常 1 天内回复