AnswerDotAI / AnswerDotAI/nbdev

nbdev_readme fails with mysterious error if docstring contains "\"

Aperta
#1,455 1 commento 0 reazioni 0 assegnatari Vedi su GitHub
bug
Lingua principale
Jupyter Notebook
Stelle
5.3k
Fork
513
Merge medio
2g 30m
PR unite (30g)
8

Descrizione

`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).

Guida per i contributori

Apri la guida per i contributori

Direzione di ricerca

Inizia riproducendo il malfunzionamento con nbdev_readme usando una funzione esportata il cui docstring contiene l’espressione con barra rovesciata mostrata. Risali dall’errore generato fino alla funzione responsabile e determina se il risultato atteso è un’elaborazione riuscita o un messaggio conciso che identifichi il problema con la barra rovesciata.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Valutazione

Stack tecnologico
jupyter-notebook, python
Ambito
documentation, tooling
Tipo di issue
Bug
Difficoltà
3/5
Tempo stimato
1-2 giorni
Stato di attività
Ferma
Chiarezza
Abbastanza chiara
Idoneità per principianti
42/100

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.