GV

GeezerVison

The World Wide Web, restored to 800 pixels of glory.

Home|About|Gaming cabinet|Archives|How it works|Starter sites

On this site

  • Sign in
  • ActionsCI/CD and automation
  • CodespacesCloud development environments
  • All Features
  • Documentation
  • Training
  • Certifications
  • Build with Copilot
  • Customize Copilot
  • Integrations
  • Trending repos
  • GitHub Sponsors
  • Developer articles
  • Enterprises

This view

  • Original page
  • New address

GeezerVison is showing github.com — [2.7] bpo-29521: Fix two minor documentation build warnings (GH-41) by Mariatta · Pull Request #670 · python/cpython

Conversation

@Mariatta

@Mariatta Mariatta commented Mar 15, 2017

Copy link
Copy Markdown
Member

(cherry picked from commit 3d707be)

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.
All reactions
@JDLH @Mariatta
bpo-29521 Fix two minor documentation build warnings (#41)
bafd0af 
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)
@Mariatta Mariatta added the cherry-pick for 2.7 label Mar 15, 2017
@the-knights-who-say-ni the-knights-who-say-ni added the CLA signed label Mar 15, 2017
@Mariatta Mariatta changed the title [2.7] bpo-29521 Fix two minor documentation build warnings (GH-41) [2.7] bpo-29521: Fix two minor documentation build warnings (GH-41) Mar 15, 2017
vadmium
vadmium reviewed Mar 15, 2017
View reviewed changes
Comment thread 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.

@vadmium vadmium Mar 15, 2017

Copy link
Copy Markdown
Member

There was a problem hiding this comment.

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

In Python 2, you only get exceptions if you enable the "-tt" option. There shouldn’t be any Sphinx warning for Python 2.

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.
All reactions
@Mariatta Mariatta changed the title [2.7] bpo-29521: Fix two minor documentation build warnings (GH-41) wip [2.7] bpo-29521: Fix two minor documentation build warnings (GH-41) Mar 16, 2017
@Mariatta
remove trailing whitespace in faq/windows.rst
cf1a9cd
@Mariatta Mariatta changed the title wip [2.7] bpo-29521: Fix two minor documentation build warnings (GH-41) [2.7] bpo-29521: Fix two minor documentation build warnings (GH-41) Mar 17, 2017
@Mariatta

Mariatta commented Mar 17, 2017

Copy link
Copy Markdown
Member Author

@vadmium I cleaned up the trailing whitespace that travis build was complaining about.
Is this ok to merge now? Thanks :)
All reactions

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.
@vadmium

vadmium commented Mar 17, 2017 •
edited
Loading

Uh oh!

There was an error while loading. Please reload this page.

Copy link
Copy Markdown
Member

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.)
All reactions

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.
@Mariatta
bpo-29521: adjust wordings
f328b81
@Mariatta

Mariatta commented Mar 30, 2017

Copy link
Copy Markdown
Member Author

@vadmium I updated the wordings as suggested. Please let me know if this works :)
All reactions

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.
@vadmium

vadmium commented Mar 31, 2017

Copy link
Copy Markdown
Member

The tabnanny change looks fine to me. I have no idea if the Sphinx config is appropriate for 2.7 though.
All reactions

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.
@Mariatta
Mariatta merged commit e0cba5b into python:2.7 Apr 10, 2017
@Mariatta
Mariatta deleted the 3d707be-2.7 branch April 10, 2017 17:27
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@vadmium vadmium vadmium left review comments

Uh oh!

There was an error while loading. Please reload this page.

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

Uh oh!

There was an error while loading. Please reload this page.

4 participants

@Mariatta @vadmium @the-knights-who-say-ni @JDLH
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
You are visitor 01402503 — GeezerVison does not store the pages you look up.
Best viewed with Netscape Navigator 4.7 or Internet Explorer 6 at 800×600. No cookies required.