AnswerDotAI / AnswerDotAI/nbdev
nbdev_readme fails with mysterious error if docstring contains "\"
オープン
bug
- 主要言語
- Jupyter Notebook
- スター
- 5.3k
- フォーク
- 513
- 平均マージ
- 2日 30分
- マージ済み PR(30日)
- 8
説明
`nbdev_readme` fails if I have a backslash in the docstring of any exported function, e.g.
```
#| export
def f():
"""
Example doctring $x \mapsto y$
"""
return None
```
The resulting error message is very long and does not indicate the problem (although it does point to the offending function).
コントリビューションガイド
調査の方向性
まず、示されているバックスラッシュ式をdocstringに含むexported functionを使って、nbdev_readmeで失敗を再現します。生成されたエラーを問題のfunctionまでたどり、期待される結果が正常な処理なのか、それともバックスラッシュの問題を特定する簡潔なメッセージなのかを判断します。
索引モデルが issue の本文から書いたものです。
評価
- 技術スタック
- jupyter-notebook, python
- 領域
- documentation, tooling
- issue の種類
- バグ
- 難易度
- 3/5
- 見積もり時間
- 1〜2日
- 活発さ
- 停滞
- 明瞭さ
- おおむね明確
- 初心者へのやさしさ
- 42/100