8000 bpo-35054: Add more index entries for symbols. (GH-10064) · python/cpython@ddb961d · GitHub
[go: up one dir, main page]
Skip to content

Commit ddb961d

Browse files
serhiy-storchakaserhiy-storchaka
authored
bpo-35054: Add more index entries for symbols. (GH-10064)
1 parent 3ec9af7 commit ddb961d

26 files changed

+466
-64
lines changed

‎Doc/library/configparser.rst

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -295,6 +295,8 @@ On top of the core functionality, :class:`ConfigParser` supports
295295
interpolation. This means values can be preprocessed before returning them
296296
from ``get()`` calls.
297297

298+
.. index:: single: %; interpolation in configuration files
299+
298300
.. class:: BasicInterpolation()
299301

300302
The default implementation used by :class:`ConfigParser`. It enables
@@ -323,6 +325,8 @@ from ``get()`` calls.
323325
``%(my_dir)s/Pictures`` as the value of ``my_pictures`` and
324326
``%(home_dir)s/lumberjack`` as the value of ``my_dir``.
325327

328+
.. index:: single: $; interpolation in configuration files
329+
326330
.. class:: ExtendedInterpolation()
327331

328332
An alternative handler for interpolation which implements a more advanced

‎Doc/library/constants.rst

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -51,9 +51,10 @@ A small number of constants live in the built-in namespace. They are:
5151
See :exc:`NotImplementedError` for details on when to use it.
5252

5353

54+
.. index:: single: ...; ellipsis literal
5455
.. data:: Ellipsis
5556

56-
The same as the ellipsis literal "...". Special value used mostly in conjunction
57+
The same as the ellipsis literal "``...``". Special value used mostly in conjunction
5758
with extended slicing syntax for user-defined container data types.
5859

5960

‎Doc/library/datetime.rst

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1999,6 +1999,9 @@ Class attributes:
19991999
The UTC timezone, ``timezone(timedelta(0))``.
20002000

20012001

2002+
.. index::
2003+
single: %; datetime format
2004+
20022005
.. _strftime-strptime-behavior:
20032006

20042007
:meth:`strftime` and :meth:`strptime` Behavior

‎Doc/library/doctest.rst

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -321,6 +321,10 @@ but doctest isn't trying to do an exact emulation of any specific Python shell.
321321
NO!!!
322322
>>>
323323

324+
.. index::
325+
single: >>>; interpreter prompt
326+
single: ...; interpreter prompt
327+
324328
Any expected output must immediately follow the final ``'>>> '`` or ``'... '``
325329
line containing the code, and the expected output (if any) extends to the next
326330
``'>>> '`` or all-whitespace line.
@@ -481,6 +485,8 @@ Some details you should read once, but won't need to remember:
481485
to test a :exc:`SyntaxError` that omits the traceback header, you will need to
482486
manually add the traceback header line to your test example.
483487

488+
.. index:: single: ^; caret
489+
484490
* For some :exc:`SyntaxError`\ s, Python displays the character position of the
485491
syntax error, using a ``^`` marker::
486492

@@ -532,6 +538,7 @@ doctest decides whether actual output matches an example's expected output:
532538
option will probably go away, but not for several years.
533539

534540

541+
.. index:: single: <BLANKLINE>
535542
.. data:: DONT_ACCEPT_BLANKLINE
536543

537544
By default, if an expected output block contains a line containing only the
@@ -551,6 +558,7 @@ doctest decides whether actual output matches an example's expected output:
551558
your source.
552559

553560

561+
.. index:: single: ...; in doctests
554562
.. data:: ELLIPSIS
555563

556564
When specified, an ellipsis marker (``...``) in the expected output can match
@@ -686,6 +694,10 @@ useful unless you intend to extend :mod:`doctest` internals via subclassing:
686694
MY_FLAG = register_optionflag('MY_FLAG')
687695

688696

697+
.. index::
698+
single: #; in doctests
699+
single: +; in doctests
700+
single: -; in doctests
689701
.. _doctest-directives:
690702

691703
Directives

‎Doc/library/gettext.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -61,6 +61,7 @@ class-based API instead.
6161
*domain*, which is returned.
6262

6363

64+
.. index:: single: _; gettext
6465
.. function:: gettext(message)
6566

6667
Return the localized translation of *message*, based on the current global

‎Doc/library/os.path.rst

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -160,6 +160,8 @@ the :mod:`glob` module.)
160160
Accepts a :term:`path-like object`.
161161

162162

163+
.. index:: single: ~; home directory expansion
164+
163165
.. function:: expanduser(path)
164166

165167
On Unix and Windows, return the argument with an initial component of ``~`` or
@@ -183,6 +185,9 @@ the :mod:`glob` module.)
183185
.. versionchanged:: 3.6
184186
Accepts a :term:`path-like object`.
185187

188+
.. index::
189+
single: $; environment variables expansion
190+
single: %; environment variables expansion (Windows)
186191

187192
.. function:: expandvars(path)
188193

‎Doc/library/os.rst

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4086,20 +4086,24 @@ are defined for all platforms.
40864086
Higher-level operations on pathnames are defined in the :mod:`os.path` module.
40874087

40884088

4089+
.. index:: single: .; in pathnames
40894090
.. data:: curdir
40904091

40914092
The constant string used by the operating system to refer to the current
40924093
directory. This is ``'.'`` for Windows and POSIX. Also available via
40934094
:mod:`os.path`.
40944095

40954096

4097+
.. index:: single: ..; in pathnames
40964098
.. data:: pardir
40974099

40984100
The constant string used by the operating system to refer to the parent
40994101
directory. This is ``'..'`` for Windows and POSIX. Also available via
41004102
:mod:`os.path`.
41014103

41024104

4105+
.. index:: single: /; in pathnames
4106+
.. index:: single: \; in pathnames (Windows)
41034107
.. data:: sep
41044108

41054109
The character used by the operating system to separate pathname components.
@@ -4109,6 +4113,7 @@ Higher-level operations on pathnames are defined in the :mod:`os.path` module.
4109 92B1 4113
useful. Also available via :mod:`os.path`.
41104114

41114115

4116+
.. index:: single: /; in pathnames
41124117
.. data:: altsep
41134118

41144119
An alternative character used by the operating system to separate pathname
@@ -4117,12 +4122,14 @@ Higher-level operations on pathnames are defined in the :mod:`os.path` module.
41174122
:mod:`os.path`.
41184123

41194124

4125+
.. index:: single: .; in pathnames
41204126
.. data:: extsep
41214127

41224128
The character which separates the base filename from the extension; for example,
41234129
the ``'.'`` in :file:`os.py`. Also available via :mod:`os.path`.
41244130

41254131

4132+
.. index:: single: :; path separator (POSIX)
41264133
.. data:: pathsep
41274134

41284135
The character conventionally used by the operating system to separate search

0 commit comments

Comments
 (0)
0