patchcheck should handle extraneous whitespace in .rst files

[brettcannon]

BPO	9095
Nosy	@brettcannon, @birkenfeld, @merwok

^{Note: these values reflect the state of the issue at the time it was migrated and might not reflect the current state.}

Show more details

GitHub fields:

assignee = 'https://github.com/merwok'
closed_at = <Date 2010-10-21.12:50:05.070>
created_at = <Date 2010-06-27.23:59:41.661>
labels = ['easy', 'type-feature']
title = 'patchcheck should handle extraneous whitespace in .rst files'
updated_at = <Date 2010-11-22.21:32:58.442>
user = 'https://github.com/brettcannon'

bugs.python.org fields:

activity = <Date 2010-11-22.21:32:58.442>
actor = 'georg.brandl'
assignee = 'eric.araujo'
closed = True
closed_date = <Date 2010-10-21.12:50:05.070>
closer = 'georg.brandl'
components = ['Demos and Tools']
creation = <Date 2010-06-27.23:59:41.661>
creator = 'brett.cannon'
dependencies = []
files = []
hgrepos = []
issue_num = 9095
keywords = ['easy']
message_count = 8.0
messages = ['108808', '108909', '108925', '109254', '119283', '122126', '122156', '122168']
nosy_count = 3.0
nosy_names = ['brett.cannon', 'georg.brandl', 'eric.araujo']
pr_nums = []
priority = 'low'
resolution = 'accepted'
stage = 'needs patch'
status = 'closed'
superseder = None
type = 'enhancement'
url = 'https://bugs.python.org/issue9095'
versions = ['Python 3.2']

[brettcannon]

Tools/scripts/reindent-rst.py already exists, so this should be simple to add.

[merwok]

Feel free to assign patchcheck bugs to me. I’ll write a patch and then assign to you for review.

[brettcannon]

Knock yourself out!

[merwok]

Please apply the refactor patch in bpo-8912

[birkenfeld]

Now done in r85767.

[merwok]

I tried to use “make patchcheck” after edits to reST files and it hung. Do you have the same behavior? I suspect reindent-rst is the culprit.

I’m wondering about the reindenting; other checks in patchcheck don’t edit files, they just print warnings. On the other hand, removing trailing whitespace and reindenting is not a very good use of people’s time, so having a tool do them is good.

[brettcannon]

Just ran it without issue after doing an svn up.

As for fix vs. not, while fixing indentations and removing trailing whitespace is nice, it isn't necessary. Both instances should be a rarity (most IDEs will make sure the situation doesn't occur), so the most important thing is detecting there is an issue for people to fix them (along with providing as much info as possible to make it easy to fix) rather than fixing it for them (if that turns out to be somewhat complicated to do).

[birkenfeld]

patchcheck.py is not so complicated; why don't you debug that hangup yourself?