Sphinx (Travis doc build) is blocking merging

[terryjreedy]

BPO	37644
Nosy	@terryjreedy, @vstinner, @ned-deily, @zware, @JulienPalard, @ammaraskar, @miss-islington
PRs	bpo-37644: update suspicious.csv for distutils/examples #14885 [3.8] bpo-37644: update suspicious.csv for distutils/examples (GH-14885) #14886 bpo-37644: Fix susp-ignored.csv to not break CI #14887

^{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 = None
closed_at = <Date 2019-07-21.18:12:31.957>
created_at = <Date 2019-07-21.16:48:55.880>
labels = ['3.8', 'type-bug', 'tests', '3.9']
title = 'Sphinx (Travis doc build) is blocking merging'
updated_at = <Date 2019-07-21.18:39:04.294>
user = 'https://github.com/terryjreedy'

bugs.python.org fields:

activity = <Date 2019-07-21.18:39:04.294>
actor = 'terry.reedy'
assignee = 'none'
closed = True
closed_date = <Date 2019-07-21.18:12:31.957>
closer = 'ned.deily'
components = ['Tests']
creation = <Date 2019-07-21.16:48:55.880>
creator = 'terry.reedy'
dependencies = []
files = []
hgrepos = []
issue_num = 37644
keywords = ['patch', '3.8regression']
message_count = 5.0
messages = ['348253', '348254', '348256', '348258', '348260']
nosy_count = 7.0
nosy_names = ['terry.reedy', 'vstinner', 'ned.deily', 'zach.ware', 'mdk', 'ammar2', 'miss-islington']
pr_nums = ['14885', '14886', '14887']
priority = 'critical'
resolution = 'fixed'
stage = 'resolved'
status = 'closed'
superseder = None
type = 'behavior'
url = 'https://bugs.python.org/issue37644'
versions = ['Python 3.8', 'Python 3.9']

[terryjreedy]

One of the required CI tests is a Travis doc build, even if a PR does not touch any doc file. The following failure appears to be deterministic on master and 3.8. A 3.7 backport passed. It has happened multiple times on multiple PRs today. Example:
https://travis-ci.org/python/cpython/jobs/561700698
The failure is
'''
Warning, treated as error:
[distutils/examples:267] "`" found in "This is the description of the foobar package."
'''
I have no idea why this is seen as suspicious.

I have 4 PRs blocked by this.
#14872
#14879
#14883
#14881
The last one is the 3.8 backport of a PR that passed CI maybe 12 hours ago. Its 3.7 backport passed and is merged.

If nothing else, can warnings not be treated as errors?

[ammaraskar]

This particular error used to be covered here: https://github.com/python/cpython/blob/master/Doc/tools/susp-ignored.csv but looks like a line number change has broken it.

[ned-deily]

New changeset 22f0483 by Ned Deily in branch 'master':
Bpo-37644: update suspicious.csv for distutils/examples (GH-14885)
22f0483

[miss-islington]

New changeset 8f50164 by Miss Islington (bot) in branch '3.8':
Bpo-37644: update suspicious.csv for distutils/examples (GH-14885)
8f50164

[terryjreedy]

Although the error message says line 267, the suspicious line is on 273 for the copies in my repository on windows. If 267 does not work, I will revise and merge my overlapping PR that removes the number. Most of the entries in susp-ignored.csv do not have line numbers, which seems less fragile. I don't think that this entry needs one either. The prefix "This is the description of the" does not appear elsewhere in the file, is unlikely to, and if the sentence were repeated, it would likely not be an issue anyway.