AnswerDotAI / AnswerDotAI/nbdev

nbdev_readme fails with mysterious error if docstring contains "\"

Abierto
#1,455 1 comentario 0 reacciones 0 asignados Ver en GitHub
bug
Lenguaje dominante
Jupyter Notebook
Estrellas
5.3k
Forks
513
Merge medio
2 d 30 min
PR fusionados (30 d)
8

Descripción

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

Guía de contribución

Abrir la guía de contribución

Línea de trabajo

Empieza reproduciendo el fallo con nbdev_readme usando una función exportada cuyo docstring contenga la expresión de barra invertida mostrada. Rastrea el error generado hasta la función causante y determina si el resultado esperado es un procesamiento correcto o un mensaje conciso que identifique el problema con la barra invertida.

Escrito por el modelo de indexación a partir del texto del issue.

Evaluación

Stack tecnológico
jupyter-notebook, python
Área
documentation, tooling
Tipo de issue
Error
Dificultad
3/5
Tiempo estimado
1-2 días
Estado de actividad
Estancado
Claridad
Bastante claro
Aptitud para principiantes
42/100

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.