AnswerDotAI / AnswerDotAI/nbdev
nbdev_readme fails with mysterious error if docstring contains "\"
- Vorherrschende Sprache
- Jupyter Notebook
- Sterne
- 5.3k
- Forks
- 513
- Ø Merge
- 2 T. 30 Min.
- Gemergte PRs (30 T.)
- 8
Beschreibung
`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).
Beitragsleitfaden
Rechercherichtung
Beginnen Sie damit, den Fehler mit nbdev_readme zu reproduzieren, und verwenden Sie dazu eine exportierte Funktion, deren docstring den gezeigten Backslash-Ausdruck enthält. Verfolgen Sie den erzeugten Fehler bis zur verursachenden Funktion zurück und bestimmen Sie, ob das erwartete Ergebnis eine erfolgreiche Verarbeitung oder eine knappe Meldung ist, die auf das Backslash-Problem hinweist.
Vom Indexierungsmodell aus dem Issue-Text verfasst.
Bewertung
- Tech-Stack
- jupyter-notebook, python
- Bereich
- documentation, tooling
- Issue-Typ
- Bug
- Schwierigkeit
- 3/5
- Geschätzter Aufwand
- 1-2 Tage
- Aktivitätsstatus
- Veraltet
- Klarheit
- Größtenteils klar
- Anfängerfreundlichkeit
- 42/100