Commit graph

20 commits

Author SHA1 Message Date
Miss Islington (bot)
cd95033d9c
bpo-46290: Fix parameter names in dataclasses docs (GH-30450)
(cherry picked from commit ef5376e69e)

Co-authored-by: Zsolt Dollenstein <zsol.zsol@gmail.com>
2022-01-08 07:09:58 -08:00
Miss Islington (bot)
376b24e4f6
bpo-43905: Expand dataclasses.astuple() and asdict() docs (GH-26154)
Expanded ``astuple()`` docs, warning about deepcopy being applied
and providing a workaround.

Automerge-Triggered-By: GH:ericvsmith
(cherry picked from commit c1f93f0d37)

Co-authored-by: andrei kulakov <andrei.avk@gmail.com>
2021-11-29 10:30:38 -08:00
Miss Islington (bot)
4d532d3f8f
bpo-43558: Add note about base class initialization to dataclasses doc (GH-25967) (GH-26019)
(cherry picked from commit 2a031723ee)

Co-authored-by: dhoekstra2000 <douwe.hoekstra2512@gmail.com>

Co-authored-by: dhoekstra2000 <douwe.hoekstra2512@gmail.com>
2021-05-10 09:38:01 -04:00
Miss Islington (bot)
7424105a02
Fix minor grammar problems in dataclasses documentation (GH-25948) (#25959)
Some missing words; some odd word choices.
(cherry picked from commit ee8e7c2fa9)

Co-authored-by: Scott Noyes <snoyes@gmail.com>

Co-authored-by: Scott Noyes <snoyes@gmail.com>
2021-05-06 17:54:58 -04:00
Miss Islington (bot)
e48405a9be
bpo-43971: Add spaces around annotated arg default '=' (GH-25702)
Result: "quantity_on_hand: int = 0".
(cherry picked from commit e726a902b7)

Co-authored-by: Mohamed Moselhy <look4d@gmail.com>

Co-authored-by: Mohamed Moselhy <look4d@gmail.com>
2021-04-30 20:30:38 -04:00
Miss Islington (bot)
c9c1dbd253
bpo-43938: improve dataclasses.FrozenInstanceError documentation (GH-25603) (GH-25635)
(cherry picked from commit 8a307e488d)

Co-authored-by: Llandy Riveron Del Risco <llandy3d@gmail.com>

Co-authored-by: Llandy Riveron Del Risco <llandy3d@gmail.com>
2021-04-26 15:36:23 -04:00
Miss Islington (bot)
fb3b031030
bpo-43415: Fix typo on dataclasses.rst (GH-24789) (GH-24790)
(cherry picked from commit 0554044ddc)

Co-authored-by: Guilherme Martins Crocetti <gmcrocetti@gmail.com>

Co-authored-by: Guilherme Martins Crocetti <gmcrocetti@gmail.com>
2021-03-08 17:52:43 -05:00
Miss Skeleton (bot)
5f9a08d95f
[doc] Use list[int] instead of List[int] (etc.) in a few more places (GH-22524)
This changes a few occurrences left behind by GH-22340.

Automerge-Triggered-By: @gvanrossum
(cherry picked from commit 7f54e563dc)

Co-authored-by: Andre Delfino <adelfino@gmail.com>
2020-10-03 15:33:30 -07:00
Miss Islington (bot)
b4beda1a86
bpo-41199: Docstring convention not followed for dataclasses documentation page (GH-21413)
Automerge-Triggered-By: @ericvsmith
(cherry picked from commit 61bb24a270)

Co-authored-by: marload <rladhkstn8@gmail.com>
2020-07-09 05:20:26 -07:00
Ned Batchelder
2effef7453
Make the first dataclass example more useful (GH-19994) 2020-05-08 04:39:57 -07:00
Fabio Sangiovanni
e28aff54d9 bpo-33961: Adjusted dataclasses docs to correct exceptions raised. (GH-7917) (GH-17677) 2019-12-25 17:45:30 -05:00
Serhiy Storchaka
138ccbb022
bpo-38738: Fix formatting of True and False. (GH-17083)
* "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>".
2019-11-12 16:57:03 +02:00
Serhiy Storchaka
2d88e63bfc
bpo-37163: Make the obj argument of dataclasses.replace() a positional-only. (GH-14390) 2019-06-26 19:07:44 +03:00
Cheryl Sabella
b7105c9c96 bpo-35566: Add links to annotation glossary term (GH-11291) 2018-12-23 21:09:09 -08:00
방성범 (Bang Seongbeom)
508d820512 Fix astuple in dataclasses documentation (GH-9631) 2018-09-29 06:50:31 -04:00
Daniel Dương
075b3c3259 Fix typo in the dataclasses's doc (GH-8896) 2018-08-24 05:19:24 -04:00
Tom Faulkner
da5e9476bb Dataclasses: Fix example on 30.6.8, add method should receive a list rather than an integer. (GH-8038)
Change example function to append rather than add lists.
2018-07-10 22:39:57 -04:00
Barry Warsaw
713a936736
bpo-32216: Update dataclasses documentation (#6913) 2018-05-16 15:50:07 -04:00
Eric V. Smith
7a1c027501
Minor tweaks to dataclasses docs. (GH-6903) 2018-05-16 09:29:05 -04:00
Eric V. Smith
98d50cb8f5
bpo-32216: Add documentation for dataclasses (GH-6886)
This is an initial version that likely requires much polishing. I'm adding it lay out the structure and so we have something to start working from.
2018-05-16 04:20:43 -04:00