potiuk opened a new issue #11180: URL: https://github.com/apache/airflow/issues/11180
**Description** We have the spell check implemented in sphinx-build, but I think we can do better. Currently, when you make a spelling mistake in any of the .rst docs you will find out only after you push it and wait for results (> 10 minutes). I think spell check is not as demanding when it comes to dependencies and when you modify an .rst or two you should be able to check the spelling really fast during the pre-commit without running the whole documentation build? The key here is to synchronize the exception list and the "spelling: " directive between sphinx and potential pre-commit. **Use case / motivation** I think this can be really demotivating for people who write documentation that they find spelling mistakes a long time after they submitted it. I think fast feedback (preferably at the commit time) is much more encouraging. Maybe we can find some fast pre-commit alternative that would work in 90% of cases at a pre-commit time? I believe the sphinx uses enchant library to do the spell-checking, maybe we can employ it to do a fast check? It's not something super urgent or extremely, but it becomes a bit annoying :) and may also discourage people who would like to improve some documentation. ---------------------------------------------------------------- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. For queries about this service, please contact Infrastructure at: [email protected]
