Commit1a5c4bd

authored

bpo-33185: Improve wording and markup (GH-6477)

Adds some working and markup fixes that I missedin the initial commit for this issue.(Follow-up toGH-6419)

1 parent82a9481 commit1a5c4bdCopy full SHA for 1a5c4bd

File tree

+12

-10

lines changed

+12

-10

lines changed

Lines changed: 7 additions & 5 deletions

Original file line number	Diff line number	Diff line change
`@@ -1144,11 +1144,13 @@ Changes in Python behavior`
`1144`	`1144`	`parentheses can be omitted only on calls.`
`1145`	`1145`	(Contributed by Serhiy Storchaka in:issue:`32012` and:issue:`32023`.)
`1146`	`1146`
`1147`		-* When using the ``-m`` switch, the starting directory is now added to sys.path,
`1148`		`- rather than the current working directory. Any programs that are checking for`
`1149`		- the empty string in:data:`sys.path`, or otherwise relying on the previous
`1150`		`- behaviour, will need to be updated accordingly (e.g. by checking for`
`1151`		- ``os.getcwd()`` in addition to checking for the empty string).
	`1147`	+* When using the:option:`-m` switch, the initial working directory is now added
	`1148`	+ to:data:`sys.path`, rather than an empty string (which dynamically denoted
	`1149`	`+ the current working directory at the time of each import). Any programs that`
	`1150`	`+ are checking for the empty string, or otherwise relying on the previous`
	`1151`	`+ behaviour, will need to be updated accordingly (e.g. by also checking for`
	`1152`	+ ``os.getcwd()`` or ``os.path.dirname(__main__.__file__)``, depending on why
	`1153`	`+ the code was checking for the empty string in the first place).`
`1152`	`1154`
`1153`	`1155`
`1154`	`1156`	`Changes in the Python API`

Lines changed: 1 addition & 1 deletion

Original file line number	Diff line number	Diff line change
`@@ -2643,7 +2643,7 @@ def _get_revised_path(given_path, argv0):`
`2643`	`2643`
`2644`	`2644`	`# Note: the tests only cover _get_revised_path, not _adjust_cli_path itself`
`2645`	`2645`	`def_adjust_cli_sys_path():`
`2646`		`-"""Ensures current directory is on sys.path, and __main__ directory is not`
	`2646`	`+"""Ensures current directory is on sys.path, and __main__ directory is not.`
`2647`	`2647`
`2648`	`2648`	`Exception: __main__ dir is left alone if it's also pydoc's directory.`
`2649`	`2649`	`"""`

Lines changed: 1 addition & 1 deletion

Original file line number	Diff line number	Diff line change
`@@ -1103,7 +1103,7 @@ def _get_revised_path(self, given_path, argv0=None):`
`1103`	`1103`	`returnpydoc._get_revised_path(given_path,argv0)`
`1104`	`1104`
`1105`	`1105`	`def_get_starting_path(self):`
`1106`		`-# Get a copy of sys.path without the current directory`
	`1106`	`+# Get a copy of sys.path without the current directory.`
`1107`	`1107`	`clean_path=sys.path.copy()`
`1108`	`1108`	`forspellinginself.curdir_spellings:`
`1109`	`1109`	`for__inrange(clean_path.count(spelling)):`

Lines changed: 3 additions & 3 deletions

Original file line number	Diff line number	Diff line change
`@@ -1,5 +1,5 @@`
`1`		-Fixed regression when running pydoc with the``-m`` switch. (The regression
`2`		`-was introduced in 3.7.0b3 by the resolution ofbpo-33053)`
	`1`	+Fixed regression when running pydoc with the:option:`-m` switch. (The regression
	`2`	+was introduced in 3.7.0b3 by the resolution of:issue:`33053`)
`3`	`3`
`4`		-This fix also changed pydoc to add ``os.getcwd()`` to``sys.path`` when
	`4`	+This fix also changed pydoc to add ``os.getcwd()`` to:data:`sys.path` when
`5`	`5`	necessary, rather than adding ``"."``.

Comments

(0)