`nbdev_clean` documentation partly wrong
まだ誰も着手していません。
評価
- 難易度
- 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分
- マージ済み PR（30日）
- 3
環境構築
- Dockerfile・Docker Compose ファイルなし
- プルリクエストのテンプレートなし
- コントリビューションガイドを読む
はじめの一歩
- issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
- 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- 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 1週間以上 初心者へのやさしさ 25/100
AnswerDotAI/nbdev#1587 ·
-
Interested in Windows support?対応中かも @mrexodia が 11 日前に担当しました。 オープン
難易度 4/5 3〜5日 初心者へのやさしさ 35/100
AnswerDotAI/nbdev#1584 · コメント 1 件 ·
-
難易度 3/5 1〜2日 初心者へのやさしさ 35/100
AnswerDotAI/nbdev#1583 · コメント 1 件 · リアクション 1 件 ·
-
bug
難易度 3/5 1〜2日 初心者へのやさしさ 52/100
AnswerDotAI/nbdev#1581 ·
AnswerDotAI/nbdev の issue をすべて見る
似ている issue
-
raised-by:reviewer
難易度 1/5 1〜3時間 初心者へのやさしさ 84/100
medici-finance/assay#2681 ·
メンテナーはふだん 1 日以内に返信
-
architecture desktop documentation
難易度 2/5 1〜3時間 初心者へのやさしさ 75/100
メンテナーはふだん 1 日以内に返信
-
docs pydanty:is-working
難易度 2/5 1〜3時間 初心者へのやさしさ 68/100
pydantic/pydantic-ai#10113 ·
メンテナーはふだん 1 日以内に返信
-
sオープン
難易度 1/5 1時間未満 初心者へのやさしさ 68/100
microsoft/vscode-docs#10460 ·
メンテナーはふだん 1 日以内に返信
-
triage
難易度 2/5 1〜3時間 初心者へのやさしさ 76/100
Portkey-AI/gateway#1844 ·
メンテナーはふだん 1 日以内に返信