Skip to content

Conversation

@rtobar
Copy link
Collaborator

@rtobar rtobar commented Oct 27, 2025

El step de chequeo de ortografía comenzó a fallar desde que incluímos #3346. Mi intuición es que ahora que parchamos ciertos archivos .po antes de traducirlos estamos "accidentalmente" arreglando algunas entradas que antes quizás fallaban al ser parseadas, ya sea por pospell or por msgcat, y que cuya ortografía por lo tanto nunca fue chequeada.

Aprovecho la oportunidad también de arreglar o mejorar un par de detalles en nuestro script de chequeo de ortografía.

En el proceso también ocurrió que, por coincidencia, apareció publicada la nueva versión de potodo, la cual depreca el flag -p/--path que usábamos. Esto provocó una serie de errores que llevó a que:

  • Actualizara nuestra versión de potodo a la última publicada,
  • Removiera el flag --path
  • Añadiera un nuevo step en el job de CI para que la documentación construida se pueda descargar

Además envié un pequeño PR a potodo: https://git.afpy.org/AFPy/potodo/pulls/30

@github-actions
Copy link

All entries translated, horray! 🎉

Signed-off-by: Rodrigo Tobar <rtobar@icrar.org>
Esta última versión emite una advertencia al usar -p/--path, que ya no
es necesario. Esto causa dos problemas:

 * Esta advertencia contiene un emoji, el cual no era bien entendido por
   sphinx-autorun en su configuración por defecto.
 * Al imprimirse en stderr, previene a que el output de stdout de potodo
   sea imprimido por sphinx-autorun.

Con este commit se actualiza la versión de potodo a 0.30, con lo cual se
evita la advertencia y los dos problemas asociados a ella.

Signed-off-by: Rodrigo Tobar <rtobar@icrar.org>
Por alguna razón estos errores han pasado desapercibidos hasta el
momento.

Signed-off-by: Rodrigo Tobar <rtobar@icrar.org>
* Imprime mapeo de archivos sólo si hay errores
* Path.glob() produce un map en vez de una lista. Este map se consume en
  el primer loop (al crear los archivos temporales), después del cual no
  se pueden consumir más elementos. Esto quiere decir que, en caso de
  haber fallos de ortografía, el último for que imprime el mapeo entre
  archivos no imprimía nada, dado que el objecto map ya no entregaba
  resultados.
* Usa shutil para copiar de un archivo a otro.

Signed-off-by: Rodrigo Tobar <rtobar@icrar.org>
@rtobar rtobar force-pushed the fix-spelling branch 2 times, most recently from 12b0551 to e16d677 Compare October 27, 2025 04:50
@rtobar rtobar changed the title Arregla ortografía Arregla ortografía, CI y potodo Oct 27, 2025
@marcorichetta
Copy link
Contributor

Gran aporte Raúl!

Justo estaba probando potodo localmente (uvx --with potodo potodo .), entré a compartirlo en el grupo de Telegram y llegué a este PR.

Respecto a generar el artifact de la toda la doc, esto se haría para cada PR o solo con merge a main?
Según mi memoria, en algún momento tuvimos Readthedocs en CI, que nos daba un link para ingresar y ver nuestros cambios.
Mi pregunta viene también para entender si podemos evitar generar toda la doc, cada vez que cambie alguna parte de un archivo.

@rtobar
Copy link
Collaborator Author

rtobar commented Oct 30, 2025

@marcorichetta el artifact se generaría por cada PR, y también con el merge a la rama principal. El artifact no se publica a ningún lado eso sí, es sólo para poder analizar la documentación generada de forma local por si hace falta. Como bien dices, había una integración anteriormente con readthedocs donde se generaba la documentación allí también con cada PR, pero por alguna razón ésta no está funcionando. Mientras eso se soluciona, el artifact es una buena forma de poder ver la documentación generada.

Mi pregunta viene también para entender si podemos evitar generar toda la doc, cada vez que cambie alguna parte de un archivo.

Creo que es beneficioso generar la documentación como parte de un PR, y no sé si hay una manera de sólo generar ciertas páginas. Eso sí, Sphinx evita re-generar el output de archivos que no han cambiado. Lo que creo entonces que sí podríamos intentar (no sé qué tan factible es) es cachear parte de los archivos generados por el proceso de construcción de la documentación (creo que más que nada son los .mo), de tal manera que ejecuciones subsecuentes dentro de un mismo PR no tengan que reconstruir esos archivos de no ser necesario.

Las herramientas que usamos emiten caracteres que no están en ascii, que
es el encoding por defecto que autorun usa.

Signed-off-by: Rodrigo Tobar <rtobar@icrar.org>
@rtobar rtobar merged commit 2f1667c into 3.13 Oct 30, 2025
3 checks passed
@rtobar
Copy link
Collaborator Author

rtobar commented Oct 30, 2025

Decidí tomar el comentario de @marcorichetta como evidencia de que estos cambios traen mejoras más personas necesitan, especialmente con la llegada de potodo 0.30, así que estoy ya está mergeado.

@rtobar rtobar deleted the fix-spelling branch October 31, 2025 01:21
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants