mirrors/cpython
1
0
Fork 0
mirror of https://github.com/python/cpython.git synced 2025-10-01 12:52:18 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 8

bpo-29521 Fix two minor documentation build warnings (#41) (#83)

Browse source 
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 3d707be950)
This commit is contained in:
Mariatta 2017-02-14 08:54:59 -08:00 • committed by GitHub
parent 9268855ba6
commit db3deb98e9
2 changed files with 5 additions and 4 deletions
Download patch file Download diff file Expand all files Collapse all files

7
Doc/faq/windows.rst
View file

@ -300,9 +300,10 @@ this respect, and is easily configured to use spaces: Take :menuselection:`Tools
--> Options --> Tabs`, and for file type "Default" set "Tab size" and "Indent --> Options --> Tabs`, and for file type "Default" set "Tab size" and "Indent
size" to 4, and select the "Insert spaces" radio button. size" to 4, and select the "Insert spaces" radio button.
If you suspect mixed tabs and spaces are causing problems in leading whitespace, Python raises :exc:`IndentationError` or :exc:`TabError` if mixed tabs
run Python with the :option:`-t` switch or run ``Tools/Scripts/tabnanny.py`` to and spaces are causing problems in leading whitespace.
check a directory tree in batch mode. You may also run the :mod:`tabnanny` module to check a directory tree
in batch mode.
How do I check for a keypress without blocking? How do I check for a keypress without blocking?

2
Doc/make.bat
View file

@ -86,7 +86,7 @@ goto end
:build :build
if NOT "%PAPER%" == "" ( if NOT "%PAPER%" == "" (
set SPHINXOPTS=-D latex_paper_size=%PAPER% %SPHINXOPTS% set SPHINXOPTS=-D latex_elements.papersize=%PAPER% %SPHINXOPTS%
) )
cmd /C %SPHINXBUILD% %SPHINXOPTS% -b%1 -dbuild\doctrees . %BUILDDIR%\%* cmd /C %SPHINXBUILD% %SPHINXOPTS% -b%1 -dbuild\doctrees . %BUILDDIR%\%*