Skip to content

Commit d97b7dc

Browse files
bpo-30380: Fix Sphinx 1.6.1 warnings. (#1613)
* Use explicit numbering for footnotes referred by explicit number. * Restore missed footnote reference in stdtypes.rst. * Fix literal strings formatting in howto/urllib2.rst. * Update susp-ignored.csv for zipapp.rst. * Fix suspicious mark up in Misc/NEWS.
1 parent af34e0a commit d97b7dc

File tree

7 files changed

+14
-15
lines changed

7 files changed

+14
-15
lines changed

Doc/howto/urllib2.rst

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -34,8 +34,8 @@ handling common situations - like basic authentication, cookies, proxies and so
3434
on. These are provided by objects called handlers and openers.
3535

3636
urllib.request supports fetching URLs for many "URL schemes" (identified by the string
37-
before the ":" in URL - for example "ftp" is the URL scheme of
38-
"ftp://python.org/") using their associated network protocols (e.g. FTP, HTTP).
37+
before the ``":"`` in URL - for example ``"ftp"`` is the URL scheme of
38+
``"ftp://python.org/"``) using their associated network protocols (e.g. FTP, HTTP).
3939
This tutorial focuses on the most common case, HTTP.
4040

4141
For straightforward situations *urlopen* is very easy to use. But as soon as you
@@ -511,10 +511,10 @@ than the URL you pass to .add_password() will also match. ::
511511

512512
``top_level_url`` is in fact *either* a full URL (including the 'http:' scheme
513513
component and the hostname and optionally the port number)
514-
e.g. "http://example.com/" *or* an "authority" (i.e. the hostname,
515-
optionally including the port number) e.g. "example.com" or "example.com:8080"
514+
e.g. ``"http://example.com/"`` *or* an "authority" (i.e. the hostname,
515+
optionally including the port number) e.g. ``"example.com"`` or ``"example.com:8080"``
516516
(the latter example includes a port number). The authority, if present, must
517-
NOT contain the "userinfo" component - for example "joe:[email protected]" is
517+
NOT contain the "userinfo" component - for example ``"joe:[email protected]"`` is
518518
not correct.
519519

520520

Doc/library/pyexpat.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -869,7 +869,7 @@ The ``errors`` module has the following attributes:
869869

870870
.. rubric:: Footnotes
871871

872-
.. [#] The encoding string included in XML output should conform to the
872+
.. [1] The encoding string included in XML output should conform to the
873873
appropriate standards. For example, "UTF-8" is valid, but "UTF8" is
874874
not. See https://www.w3.org/TR/2006/REC-xml11-20060816/#NT-EncodingDecl
875875
and https://www.iana.org/assignments/character-sets/character-sets.xhtml.

Doc/library/stdtypes.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -829,7 +829,7 @@ restrictions imposed by *s*.
829829

830830
The ``in`` and ``not in`` operations have the same priorities as the
831831
comparison operations. The ``+`` (concatenation) and ``*`` (repetition)
832-
operations have the same priority as the corresponding numeric operations.
832+
operations have the same priority as the corresponding numeric operations. [3]_
833833

834834
.. index::
835835
triple: operations on; sequence; types

Doc/library/xml.dom.minidom.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -248,7 +248,7 @@ utility to most DOM users.
248248

249249
.. rubric:: Footnotes
250250

251-
.. [#] The encoding name included in the XML output should conform to
251+
.. [1] The encoding name included in the XML output should conform to
252252
the appropriate standards. For example, "UTF-8" is valid, but
253253
"UTF8" is not valid in an XML document's declaration, even though
254254
Python accepts it as an encoding name.

Doc/library/xml.etree.elementtree.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1192,7 +1192,7 @@ Exceptions
11921192

11931193
.. rubric:: Footnotes
11941194

1195-
.. [#] The encoding string included in XML output should conform to the
1195+
.. [1] The encoding string included in XML output should conform to the
11961196
appropriate standards. For example, "UTF-8" is valid, but "UTF8" is
11971197
not. See https://www.w3.org/TR/2006/REC-xml11-20060816/#NT-EncodingDecl
11981198
and https://www.iana.org/assignments/character-sets/character-sets.xhtml.

Doc/tools/susp-ignored.csv

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -106,7 +106,7 @@ howto/pyporting,,::,Programming Language :: Python :: 2
106106
howto/pyporting,,::,Programming Language :: Python :: 3
107107
howto/regex,,::,
108108
howto/regex,,:foo,(?:foo)
109-
howto/urllib2,,:password,"for example ""joe:[email protected]"""
109+
howto/urllib2,,:password,"""joe:[email protected]"""
110110
library/audioop,,:ipos,"# factor = audioop.findfactor(in_test[ipos*2:ipos*2+len(out_test)],"
111111
library/bisect,32,:hi,all(val >= x for val in a[i:hi])
112112
library/bisect,42,:hi,all(val > x for val in a[i:hi])
@@ -316,8 +316,8 @@ library/xml.etree.elementtree,,:actor,"for actor in root.findall('real_person:ac
316316
library/xml.etree.elementtree,,:name,"name = actor.find('real_person:name', ns)"
317317
library/xml.etree.elementtree,,:character,"for char in actor.findall('role:character', ns):"
318318
library/zipapp,,:main,"$ python -m zipapp myapp -m ""myapp:main"""
319-
library/zipapp,,:fn,"argument should have the form ""pkg.mod:fn"", where ""pkg.mod"" is a"
320-
library/zipapp,,:callable,"""pkg.module:callable"" and the archive will be run by importing"
319+
library/zipapp,,:fn,"pkg.mod:fn"
320+
library/zipapp,,:callable,"pkg.module:callable"
321321
library/stdtypes,,::,>>> m[::2].tolist()
322322
library/sys,,`,# ``wrapper`` creates a ``wrap(coro)`` coroutine:
323323
whatsnew/3.5,,:root,'WARNING:root:warning\n'
@@ -326,7 +326,6 @@ whatsnew/3.5,,::,>>> addr6 = ipaddress.IPv6Address('::1')
326326
whatsnew/3.5,,:root,ERROR:root:exception
327327
whatsnew/3.5,,:exception,ERROR:root:exception
328328
whatsnew/changelog,,:version,import sys; I = version[:version.index(' ')]
329-
whatsnew/changelog,,`,"for readability (was ""`"")."
330329
whatsnew/changelog,,:end,str[start:end]
331330
library/binascii,,`,'`'
332331
library/uu,,`,'`'

Misc/NEWS

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -769,7 +769,7 @@ Library
769769
non-None value is passed to it.send(val).
770770

771771
- Issue #27025: Generated names for Tkinter widgets now start by the "!" prefix
772-
for readability (was "`").
772+
for readability.
773773

774774
- Issue #25464: Fixed HList.header_exists() in tkinter.tix module by addin
775775
a workaround to Tix library bug.
@@ -1624,7 +1624,7 @@ Library
16241624
non-None value is passed to it.send(val).
16251625

16261626
- Issue #27025: Generated names for Tkinter widgets now start by the "!" prefix
1627-
for readability (was "`").
1627+
for readability.
16281628

16291629
- Issue #25464: Fixed HList.header_exists() in tkinter.tix module by addin
16301630
a workaround to Tix library bug.

0 commit comments

Comments
 (0)