AnswerDotAI / AnswerDotAI/nbdev
nbdev_readme fails with mysterious error if docstring contains "\"
- Langage dominant
- Jupyter Notebook
- Étoiles
- 5.3k
- Forks
- 513
- Merge moyen
- 2 j 30 min
- PR mergées (30 j)
- 8
Description
`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).
Guide de contribution
Ouvrir le guide de contribution
Piste de recherche
Commencez par reproduire l’échec avec nbdev_readme en utilisant une fonction exportée dont le docstring contient l’expression avec barre oblique inverse indiquée. Remontez de l’erreur générée jusqu’à la fonction à l’origine du problème et déterminez si le résultat attendu est un traitement réussi ou un message concis identifiant le problème lié à la barre oblique inverse.
Rédigé par le modèle d'indexation à partir du texte de l'issue.
Évaluation
- Stack technique
- jupyter-notebook, python
- Domaine
- documentation, tooling
- Type d'issue
- Bug
- Difficulté
- 3/5
- Temps estimé
- 1-2 jours
- Activité
- À l'abandon
- Clarté
- Plutôt claire
- Accessibilité débutants
- 42/100