python / python/python-docs-es
`pospell` fails with code entries
Nadie ha tomado este issue todavía.
- Lenguaje dominante
- Python
- Estrellas
- 371
- Forks
- 413
- Métricas de merge de PR
- Sin PR fusionados en 30 d
Descripción
For 3.13, there was a change in the documentation that now snippets were marked as translatable.
This means that there is a large number of "new entries" that are snippets from the documentation page.
Even though I believe this is a great thing, the tooling around might need to be adapted.
Recently I discovered that in some cases, pospell fails to parse and handle such entries.
For example:
#: ../Doc/library/typing.rst:3167
msgid ""
"@type_check_only\n"
"class Response: # private or not available at runtime\n"
" code: int\n"
" def get_header(self, name: str) -> str: ...\n"
"\n"
"def fetch_response() -> Response: ..."
msgstr ""
"@type_check_only\n"
"class Response: # privada o no disponible en runtime\n"
" code: int\n"
" def get_header(self, name: str) -> str: ...\n"
"\n"
"def fetch_response() -> Response: ..."
Produces a
<rst-doc>:3: (ERROR/3) Unexpected indentation. while parsing: @type_check_only
class Response: # privada o no disponible en runtime
code: int
def get_header(self, name: str) -> str: ...
def fetch_response() -> Response: ...
Marking those entries as fuzzy or adding three back-ticks "```" doesn't work, so I'm trying to brainstorm a bit how we could solve this.
A couple of ideas would be to:
- Just try to fix at the docutils level (which is the source of the parsing error)
- Introduce a new identifier like
python-formatin order to take the content for granted and avoid parsing it.
Ideas?
CC: @JulienPalard
Guía de contribución
No hay ninguna guía de contribución indexada para este repositorio
Primeros pasos
- Lee el issue completo y luego la guía de contribución del proyecto.
- Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
- Haz un fork del repositorio y trabaja en una rama.
- Abre un pull request que haga referencia al número del issue.
Línea de trabajo
Reproduce el fallo con la entrada PO multilínea a la que se hace referencia en Doc/library/typing.rst y, después, inspecciona cómo pospell pasa las entradas de código a docutils. Determina si el cambio necesario debe hacerse en pospell o en el nivel de docutils; el trabajo debe considerarse terminado cuando estas entradas se procesen sin el error de análisis indicado.
Escrito por el modelo de indexación a partir del texto del issue.
Evaluación
- Stack tecnológico
- python
- Área
- documentation, tooling
- Tipo de issue
- Error
- Dificultad
- 4/5
- Tiempo estimado
- 3-5 días
- Estado de actividad
- Estancado
- Claridad
- Necesita aclaración
- Aptitud para principiantes
- 25/100