Skip to content

Commit b8b9f95

Browse files
[2.7] bpo-30380: Fix Sphinx 1.6.1 warnings. (GH-1613) (#1616)
* Use explicit numbering for footnotes referred by explicit number. * Fix literal strings formatting in howto/urllib2.rst. * Add `:noindex:` to duplicated definition of list. * Update susp-ignored.csv for reference/expressions.rst. (cherry picked from commit d97b7dc)
1 parent 97eb2a7 commit b8b9f95

File tree

6 files changed

+11
-10
lines changed

6 files changed

+11
-10
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
urllib2 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
@@ -498,10 +498,10 @@ than the URL you pass to .add_password() will also match. ::
498498

499499
``top_level_url`` is in fact *either* a full URL (including the 'http:' scheme
500500
component and the hostname and optionally the port number)
501-
e.g. "http://example.com/" *or* an "authority" (i.e. the hostname,
502-
optionally including the port number) e.g. "example.com" or "example.com:8080"
501+
e.g. ``"http://example.com/"`` *or* an "authority" (i.e. the hostname,
502+
optionally including the port number) e.g. ``"example.com"`` or ``"example.com:8080"``
503503
(the latter example includes a port number). The authority, if present, must
504-
NOT contain the "userinfo" component - for example "joe:[email protected]" is
504+
NOT contain the "userinfo" component - for example ``"joe:[email protected]"`` is
505505
not correct.
506506

507507

Doc/library/functions.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -741,6 +741,7 @@ section.
741741

742742

743743
.. class:: list([iterable])
744+
:noindex:
744745

745746
Return a list whose items are the same and in the same order as *iterable*'s
746747
items. *iterable* may be either a sequence, a container that supports

Doc/library/pyexpat.rst

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

912912
.. rubric:: Footnotes
913913

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

Doc/library/xml.dom.minidom.rst

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

274274
.. rubric:: Footnotes
275275

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

Doc/library/xml.etree.elementtree.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1031,7 +1031,7 @@ This is an example of counting the maximum depth of an XML file::
10311031

10321032
.. rubric:: Footnotes
10331033

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

Doc/tools/susp-ignored.csv

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,7 @@ howto/pyporting,,::,Programming Language :: Python :: 2
4646
howto/pyporting,,::,Programming Language :: Python :: 3
4747
howto/regex,,::,
4848
howto/regex,,:foo,(?:foo)
49-
howto/urllib2,,:password,"for example ""joe:[email protected]"""
49+
howto/urllib2,,:password,"""joe:[email protected]"""
5050
library/audioop,,:ipos,"# factor = audioop.findfactor(in_test[ipos*2:ipos*2+len(out_test)],"
5151
library/bisect,,:hi,all(val >= x for val in a[i:hi])
5252
library/bisect,,:hi,all(val > x for val in a[i:hi])
@@ -152,7 +152,7 @@ reference/datamodel,,:step,a[i:j:step]
152152
reference/datamodel,,:max,
153153
reference/expressions,,:index,x[index:index]
154154
reference/expressions,,`,`expressions...`
155-
reference/expressions,,`,"""`"""
155+
reference/expressions,350,`,`
156156
reference/grammar,,`,'`' testlist1 '`'
157157
reference/lexical_analysis,,:fileencoding,# vim:fileencoding=<encoding-name>
158158
reference/lexical_analysis,,`,", : . ` = ;"

0 commit comments

Comments
 (0)