AnswerDotAI / AnswerDotAI/nbdev
nbdev_readme fails with mysterious error if docstring contains "\"
未关闭
bug
- 主要语言
- Jupyter Notebook
- 星标
- 5.3k
- 派生
- 514
- 平均合并
- 2 天 30 分钟
- 30 天内合并 PR
- 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 包含所示反斜杠表达式的导出函数,通过 nbdev_readme 重现该失败。将生成的错误追溯到有问题的函数,并确定预期结果是成功处理,还是一条指出反斜杠问题的简洁消息。
由索引模型根据 Issue 内容生成。
评估
- 技术栈
- jupyter-notebook, python
- 领域
- documentation, tooling
- Issue 类型
- 缺陷
- 难度
- 3/5
- 预计耗时
- 1-2 天
- 活跃度
- 停滞
- 描述清晰度
- 基本清楚
- 新手友好度
- 42/100