Skip to content

Introduce sphinx-lint #2234

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Dec 2, 2022
Merged

Introduce sphinx-lint #2234

merged 2 commits into from
Dec 2, 2022

Conversation

rtobar
Copy link
Collaborator

@rtobar rtobar commented Nov 28, 2022

Estos commits agregan sphinx-lint a los varios lugares donde se realizan chequeos (CI, pre-commit, Makefile). Para asegurar que nuevas versiones de sphinx-lint que pueden traer nuevos correctores no quiebran nuestros builds, la versión de sphinx-lint está definida a un valor exacto en vez de dejarla fluctuar; más tarde un dependabot nos puede avisar cuando haya una nueva versión ;)

Escribí un poquito de documentación que ojalá sea útil para cuando estos errores aparezcan, pero no sé si es suficiente.

Además, al arreglar uno de los errores el spell chequer encontró un typo
que antes pasaba desapercibido.
Ya que de versión a versión nuevos chequeos pueden ser agregados,
preferí hacer un pin de la versión y así asegurar la estabilidad de las
corridas. Un dependabot podría luego chequear si hay versiones nuevas y
mostrarnos si acaso hay errores nuevos en el linteo o no.
@rtobar
Copy link
Collaborator Author

rtobar commented Nov 28, 2022

El chequeo demora unos ~30 segundos en el GitHub Action, así que parece ser un costo relativamente despreciable.

@cmaureir
Copy link
Collaborator

A mi me parece bien, alguna otra opinión antes de hacer merge?

@cmaureir cmaureir merged commit fe28587 into python:3.11 Dec 2, 2022
@cmaureir
Copy link
Collaborator

cmaureir commented Dec 2, 2022

Muchas gracias!

@rtobar rtobar deleted the sphinx-lint branch December 11, 2022 06:35
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.

2 participants