[2.7] bpo-29521: Fix two minor documentation build warnings (GH-41) #670
Conversation
Much of bpo-29521 was fixed in parallel with commit e7ffb99 . This cleans up the rest. Apply parallel change to Doc/make.bat to read "set SPHINXOPTS=-D latex_elements.papersize=" I don't have a Windows system on which to observe the warning, but it should be necessary. The warning: .../workspace/cpython_github/Doc/faq/windows.rst:303: WARNING: unknown option: -t In the Windows FAQ, `How do I keep editors from inserting tabs into my Python source?`, contained a reference to a Python -t option. In Python 2.x, this caused Python to issue warnings about lines with mixed spaces and tabs, but as of Python 3.6 it does nothing. Per discussion at http://bugs.python.org/issue29387, take their wording. Python [3] raises an IndentationError or TabError. Tabnanny is now a module. (cherry picked from commit 3d707be)
Doc/faq/windows.rst
Outdated
| run Python with the :option:`-t` switch or run ``Tools/Scripts/tabnanny.py`` to | ||
| check a directory tree in batch mode. | ||
| Python raises :exc:`IndentationError` or :exc:`TabError` if mixed tabs | ||
| and spaces are causing problems in leading whitespace. |
There was a problem hiding this comment.
In Python 2, you only get exceptions if you enable the "-tt" option. There shouldn’t be any Sphinx warning for Python 2.
|
@vadmium I cleaned up the trailing whitespace that travis build was complaining about. |
|
Sorry I was actually talking about the original warning that I reported https://bugs.python.org/issue29387: faq/windows.rst:303: WARNING: unknown option: -t This pull request is for the 2.7 branch. As far as I remember, the above warning should not be present on the 2.7 branch, because the “-t” option is useful and is documented at https://docs.python.org/2.7/using/cmdline.html#cmdoption-t. Plus the new text is wrong: by default, Python 2 will accept code with mixed tabs and spaces in some cases. I suggest just fixing the second half of the sentence: If you suspect mixed tabs and spaces are causing problems in leading whitespace,
run Python with the :option:`-t` switch or run the :mod:`tabnanny` module to
check a directory tree in batch mode.(I would have done this myself, but I haven’t caught up with all the Git Hub changes.) |
|
@vadmium I updated the wordings as suggested. Please let me know if this works :) |
|
The tabnanny change looks fine to me. I have no idea if the Sphinx config is appropriate for 2.7 though. |
(cherry picked from commit 3d707be)