Commit Graph

478 Commits

Author SHA1 Message Date
Miss Islington (bot) b068d892c1
bpo-39301: State that floor division is used for right shift operations (GH-20347) (GH-20416)
* bpo-39301: State that floor division is used for right shift operations

* Remove "without overflow check"
(cherry picked from commit af7553ac95)

Co-authored-by: Zackery Spytz <zspytz@gmail.com>

Co-authored-by: Zackery Spytz <zspytz@gmail.com>
2020-05-26 09:34:04 +01:00
Miss Islington (bot) f8f163c38f
Fix misleading statement about mixed-type numeric comparisons (GH-18615) (GH-18737)
(cherry picked from commit 9f1cb1bb49)

Co-authored-by: Mark Dickinson <dickinsm@gmail.com>
2020-03-03 11:22:56 -05:00
Serhiy Storchaka 42b619ac9a
[3.7] bpo-38738: Fix formatting of True and False. (GH-17083) (GH-17128)
* "Return true/false" is replaced with "Return ``True``/``False``"
  if the function actually returns a bool.
* Fixed formatting of some True and False literals (now in monospace).
* Replaced "True/False" with "true/false" if it can be not only bool.
* Replaced some 1/0 with True/False if it corresponds the code.
* "Returns <bool>" is replaced with "Return <bool>".
(cherry picked from commit 138ccbb022)
2019-11-12 20:07:20 +02:00
Miss Islington (bot) 50ecedc103
Doc: Clarify dict equality irrespective of ordering. (GH-16266)
(cherry picked from commit 3171d67a6a)

Co-authored-by: toonarmycaptain <toonarmycaptain@hotmail.com>
2019-09-18 22:57:32 -07:00
Miss Islington (bot) 89f132a328 Doc: Add list(dict) in stdtypes library (GH-16209) (GH-16211)
(cherry picked from commit 63dedef48b)

Co-authored-by: Adorilson Bezerra <adorilson@gmail.com>
2019-09-17 07:04:19 +02:00
Miss Islington (bot) 3cd147bf59
bpo-37585: Add clarification regarding comparing dict.values() (GH-14954)
(cherry picked from commit 6472ece5a0)

Co-authored-by: Kyle Stanley <aeros167@gmail.com>
2019-09-11 03:45:54 -07:00
Miss Islington (bot) 9210b5826f
bpo-16438: Doc: confusing text regarding numeric precedence corrected (GH-10521)
(cherry picked from commit 4576b5431b)

Co-authored-by: Anjali <anjali30malik@gmail.com>
2019-09-11 03:41:28 -07:00
Miss Islington (bot) 0fcdd8d6d6
bpo-36502: Correct documentation of str.isspace() (GH-15019) (GH-15296)
The documented definition was much broader than the real one:
there are tons of characters with general category "Other",
and we don't (and shouldn't) treat most of them as whitespace.

Rewrite the definition to agree with the comment on
_PyUnicode_IsWhitespace, and with the logic in makeunicodedata.py,
which is what generates that function and so ultimately governs.

Add suitable breadcrumbs so that a reader who wants to pin down
exactly what this definition means (what's a "bidirectional class"
of "B"?) can do so.  The `unicodedata` module documentation is an
appropriate central place for our references to Unicode's own copious
documentation, so point there.

Also add to the isspace() test a thorough check that the
implementation agrees with the intended definition.
(cherry picked from commit 8c1c426a63)

Co-authored-by: Greg Price <gnprice@gmail.com>
2019-08-19 03:10:14 -07:00
Miss Islington (bot) 8b1135fc60
Doc: Fix example title. (GH-14639)
(cherry picked from commit 66b4150f6f)

Co-authored-by: Julien Palard <julien@palard.fr>
2019-07-08 14:18:15 -07:00
Miss Islington (bot) 04b114eede
bpo-36416: Correct bytes.rpartition documentation (GH-12543)
(cherry picked from commit efc4870149)

Co-authored-by: pewscorner <pewscorner@users.noreply.github.com>
2019-04-11 03:18:48 -07:00
Miss Islington (bot) bf44f48b63
Fix the documentation for set.copy() (GH-12176)
Remove 's' mention as there's no argument.
(cherry picked from commit e942e7b5c9)

Co-authored-by: Andre Delfino <adelfino@gmail.com>
2019-03-06 21:30:33 -08:00
Miss Islington (bot) a58c8442f1 Document that dict.fromkeys accepts any iterable for keys (GH-10998) (GH-11294)
(cherry picked from commit f06fba5965)

Co-authored-by: Andre Delfino <adelfino@gmail.com>
2018-12-22 20:56:01 -08:00
Serhiy Storchaka 1e47fbcf78
[3.7] bpo-35506: Remove redundant and incorrect links from keywords. (GH-11174). (GH-11232)
(cherry picked from commit 2b57c43f21)
2018-12-19 09:28:12 +02:00
Miss Islington (bot) b3ffe47bcb
Fix numbered lists in stdtypes.rst. (GH-10989)
(cherry picked from commit de9e9b476e)

Co-authored-by: Andre Delfino <adelfino@gmail.com>
2018-12-10 12:51:32 -08:00
Miss Islington (bot) 349d9910b2
Correct a couple of unbalanced parenthesis. (GH-10779)
(cherry picked from commit 55f41e45b4)

Co-authored-by: Andre Delfino <adelfino@gmail.com>
2018-12-05 12:15:54 -08:00
Miss Islington (bot) 8a54c67701
Correct grammar mistake in stdtypes.rst (GH-10481)
(cherry picked from commit 7610f4fe93)

Co-authored-by: Andrés Delfino <adelfino@gmail.com>
2018-11-12 09:45:05 -08:00
Miss Islington (bot) f455dd53af
Mark len call as a code snippet in stdtypes.rst. (GH-9804)
(cherry picked from commit ca03f3b93e)

Co-authored-by: Andrés Delfino <adelfino@gmail.com>
2018-11-07 09:54:41 -08:00
Miss Islington (bot) fdf48b6b88 bpo-35054: Add yet more index entries for symbols. (GH-10121) (GH-10171)
(cherry picked from commit 913876d824)

Co-authored-by: Serhiy Storchaka <storchaka@gmail.com>
2018-10-28 18:43:32 +02:00
Serhiy Storchaka 9a75b8470a
[3.7] bpo-35054: Add more index entries for symbols. (GH-10064). (GH-10120)
(cherry picked from commit ddb961d2ab)

Co-authored-by: Serhiy Storchaka <storchaka@gmail.com>
2018-10-26 11:18:42 +03:00
Miss Islington (bot) 3e648f8371
bpo-28617 Fixed docs inaccuracies about the types that support membership tests (GH-9086)
<!-- issue-number: [bpo-28617](https://www.bugs.python.org/issue28617) -->
https://bugs.python.org/issue28617
<!-- /issue-number -->
(cherry picked from commit 08bcf647d8)

Co-authored-by: wim glenn <wim.glenn@gmail.com>
2018-09-11 11:13:33 -07:00
Miss Islington (bot) 6dc8f05437
Fix markup in stdtypes documentation (GH-8905)
(cherry picked from commit 2e5d2ea208)

Co-authored-by: Andrés Delfino <adelfino@gmail.com>
2018-08-25 10:22:00 -04:00
Miss Islington (bot) 0fd6f832a9 bpo-34432: doc Mention complex and decimal.Decimal on str.format note about locales (GH-8808) (GH-8809)
(cherry picked from commit 93b5655c04)

Co-authored-by: Andrés Delfino <adelfino@gmail.com>
2018-08-18 14:16:36 -04:00
Miss Islington (bot) b4d71c9149
Improve the grammar in `range` documentation. (GH-8628)
Remove unnecessary "that" in the sentence.
(cherry picked from commit b6efc2cf97)

Co-authored-by: Andrés Delfino <adelfino@gmail.com>
2018-08-02 23:16:07 -07:00
Miss Islington (bot) 8764a6ffda
bpo-29710: Clarify documentation for Bitwise binary operation (GH-1691)
Mathematically, bitwise operations on integers behave as if there were an
infinite number of sign bits. Pragmatically, that gives the same answer as
using one extra sign bit for the bitwise logical operations.
(cherry picked from commit b4bc5cab82)

Co-authored-by: Sanyam Khurana <8039608+CuriousLearner@users.noreply.github.com>
2018-07-28 09:52:14 -07:00
Miss Islington (bot) 7cf7541aa4 Fix versionchanged indentation in popitem documentation (GH-8387)
(cherry picked from commit cb9c299a55)

Co-authored-by: Andrés Delfino <adelfino@gmail.com>
2018-07-21 16:04:54 -07:00
Miss Islington (bot) bfa8a358e2 bpo-34123: Fix missed documentation update for dict.popitem(). (GH-8292) (GH#8307) 2018-07-16 19:08:13 -07:00
Miss Islington (bot) c8b18d3192
Add missing closing parentheses (GH-8144)
(cherry picked from commit 03dd0e794e)

Co-authored-by: Andrés Delfino <adelfino@gmail.com>
2018-07-07 12:19:55 -07:00
Miss Islington (bot) 80f1a908a8 bpo-33952: Fix typo in str.upper() documentation (GH-7898) (GH-7903)
(cherry picked from commit 4a6e746079)

Co-authored-by: Andrés Delfino <adelfino@gmail.com>
2018-06-25 13:42:20 +03:00
Miss Islington (bot) ce1bda774e bpo-33854: Add PEP 461 title to 'See also' note (GH-7688) (#7719)
(cherry picked from commit a9d0b34a5c)

Co-authored-by: Andrés Delfino <adelfino@gmail.com>
2018-06-15 16:14:32 -04:00
Miss Islington (bot) 9b0d4d04a1 bpo-33609: small wording fixes to dict ordering docs (#7497)
A few wording improvements to dict ordering documentation.
(cherry picked from commit d3ed67d14e)

Co-authored-by: Neil Schemenauer <nas-github@arctrix.com>
2018-06-07 20:38:22 -04:00
Miss Islington (bot) 8585ec9b76
bpo-33609: Document dict insertion order guarantee as of 3.7 (GH-7093)
(cherry picked from commit f822549653)

Co-authored-by: INADA Naoki <methane@users.noreply.github.com>
2018-06-04 15:25:12 -07:00
Miss Islington (bot) 9216dffbc8
bpo-32337: Update documentats about dict order (GH-4973)
(cherry picked from commit dfbbbf16f9)

Co-authored-by: hui shang <shangdahao@gmail.com>
2018-04-03 22:01:46 -07:00
INADA Naoki a49ac99029
bpo-32677: Add .isascii() to str, bytes and bytearray (GH-5342) 2018-01-27 14:06:21 +09:00
Victor Stinner cb064fc232
bpo-31900: Fix localeconv() encoding for LC_NUMERIC (#4174)
* Add _Py_GetLocaleconvNumeric() function: decode decimal_point and
  thousands_sep fields of localeconv() from the LC_NUMERIC encoding,
  rather than decoding from the LC_CTYPE encoding.
* Modify locale.localeconv() and "n" formatter of str.format() (for
  int, float and complex to use _Py_GetLocaleconvNumeric()
  internally.
2018-01-15 15:58:02 +01:00
Nitish Chandra 5ce0a2a100 bpo-31942: Document optional support of start and stop attributes in Sequence.index method (#4277) 2017-12-12 11:22:30 +01:00
Serhiy Storchaka a2314283ff
bpo-20047: Make bytearray methods partition() and rpartition() rejecting (#4158)
separators that are not bytes-like objects.
2017-10-29 02:11:54 +03:00
Peter Thomassen caa1280d1e bpo-30803: clarify truth value testing documentation (#2508)
Initial patch by Peter Thomassen.
2017-07-29 15:18:13 -04:00
Łukasz Rogalski be37beb05f Doc that 'sorted' args are keyword-only, fix 'reverse' default (#2706) 2017-07-14 15:23:39 -04:00
Benjamin Peterson 279a96206f bpo-30736: upgrade to Unicode 10.0 (#2344)
Straightforward. While we're at it, though, strip trailing whitespace from generated tables.
2017-06-22 22:31:08 -07:00
Marco Buttu 5eb7075915 bpo-30217: Add the operators ~ and | to the index (#1502) 2017-06-09 17:28:27 +03:00
Julien 0737ee2067 bpo-30499: Remove a deprecated note about sets. (GH-1848) 2017-06-01 07:02:21 -07:00
Sanyam Khurana 08e2f355d0 bpo-22702: Clarify documentation of str.join & bytes.join (GH-156)
The "iterable iterable" phrasing created confusion between the term
reference and the parameter name.

This simplifies the phrasing to just use the parameter name
without linking directly to the term definition.
2017-05-27 15:44:41 +10:00
Serhiy Storchaka d97b7dc94b 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.
2017-05-16 23:18:09 +03:00
csabella c6db4811f9 bpo-30052: Link `bytes` & `bytearray` to stdtypes not functions (GH-1271)
Builtin container types have two potential link targets in the docs:

- their entry in the list of builtin callables
- their type documentation

This change brings `bytes` and `bytearray` into line with other
container types by having cross-references default to linking to
their type documentation, rather than their builtin callable entry.
2017-04-26 15:47:01 +10:00
Barry Warsaw 9f74deba78 Improve the documentation for template strings (#856)
bpo-19824
bpo-20314
bpo-12518
2017-03-28 10:02:07 -04:00
Xiang Zhang b2d77175d1 bpo-29756: Improve documentation for list methods that compare items by equality (GH-572) 2017-03-13 10:09:16 +08:00
Mariatta 8eb531d9db bpo-29709: Improve Boolean Operations documentation (#433)
Change False into false, and True into true.
2017-03-03 13:16:29 -08:00
Xiang Zhang dfe14c462d Issue #29112: Merge 3.6. 2016-12-30 11:58:14 +08:00
Xiang Zhang 9ea82ddad5 Issue #29112: Merge 3.5. 2016-12-30 11:57:40 +08:00
Xiang Zhang cea904f286 Issue #29112: Fix a questionable wording in sequence doc. 2016-12-30 11:57:09 +08:00