[GitHub] [airflow] RNHTTR edited a comment on issue #14051: Docs Builder creates SpellingError for Sphinx error unrelated to spelling issues

[GitBox <gi...@apache.org>]

RNHTTR edited a comment on issue #14051:
URL: https://github.com/apache/airflow/issues/14051#issuecomment-777151233


   I don't think so. If someone ran with the `--spellcheck-only` flag, they'd still get the error.
   
   I think it would be helpful and easy to just update the error message at https://github.com/apache/airflow/blob/master/docs/exts/docs_build/spelling_checks.py#L149-L152 to encourage the developer to review the traceback and note that if no spelling errors were included in the summary that it might not be a spelling error. For example:
   
   ```
       msg = """
   If there are spelling errors in the above summary, and the spelling is correct, add the spelling to docs/spelling_wordlist.txt
   or use the spelling directive.
   Check https://sphinxcontrib-spelling.readthedocs.io/en/latest/customize.html#private-dictionaries
   for more details.
   
   If there are no spelling errors in the above summary, there might be an issue unrelated to spelling. Please review the 
   traceback. 
       """
   ``` 
   
   This at least would have helped me realize that my error was unrelated to spelling. Thoughts?


----------------------------------------------------------------
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:
users@infra.apache.org