gh-60712: Include the "object" type in the lists of documented types #103036

furkanonder · 2023-03-25T20:56:04Z

Issue: Include the "object" type in the lists of documented types #60712

Co-Authored-By: @vadmium

Lib/test/test_class.py

terryjreedy · 2023-03-29T17:56:15Z

The original author was Martin Panter, @vadmium. I fixed the co-authorship note.

CAM-Gerlach

Standard reminder: You can directly apply all the suggestions you want in one go by going to Files changed -> Clicking Add to batch on each suggestion -> When done, clicking Commit

Thanks! Various further textual, syntactic and formatting fixes.

Misc/NEWS.d/next/Documentation/2023-03-28-22-24-45.gh-issue-60712.So5uad.rst

Doc/library/stdtypes.rst

Doc/reference/datamodel.rst

Co-authored-by: C.A.M. Gerlach <[email protected]>

Doc/library/functions.rst

Co-authored-by: C.A.M. Gerlach <[email protected]>

'dictionaries' to 'dict' Co-authored-by: C.A.M. Gerlach <[email protected]>

terryjreedy

I have not reviewed changes to special methods section. Will make other changes on my local copy.

Doc/reference/datamodel.rst

Doc/library/stdtypes.rst

Doc/reference/datamodel.rst

Lib/test/test_class.py

bedevere-bot · 2023-06-18T22:36:43Z

A Python core developer has requested some changes be made to your pull request before we can consider merging it. If you could please address their requests along with any other requests in other reviews from core developers that would be appreciated.

Once you have made the requested changes, please leave a comment on this pull request containing the phrase I have made the requested changes; please review again. I will then notify any core developers who have left a review that you're ready for them to take another look at this pull request.

Doc/library/stdtypes.rst

Doc/reference/datamodel.rst

merwok · 2024-10-21T14:10:13Z

Doc/reference/datamodel.rst

 :class:`tuples <tuple>`) or :term:`mappings <mapping>` (like
-:class:`dictionaries <dict>`),
+:term:`dictionaries <dictionary>`),


🤔 Hm… on the line before, we see a general term used (with a link to glossary) and a concrete example in parens (list and tuple links), then we have the general/glossary term mappings and should keep the specific type dict in parens to keep the intent of the text. On the other hand, if the glossary term for dictionaries is a better explanation than the dict type/function doc, and more specific than the term for mappings, the changed link could be an improvement.

Co-authored-by: Éric <[email protected]>

Doc/reference/datamodel.rst

Co-authored-by: Éric <[email protected]>

Addressed in PR

miss-islington-app · 2024-10-30T18:20:06Z

Thanks @furkanonder for the PR, and @willingc for merging it 🌮🎉.. I'm working now to backport this PR to: 3.12, 3.13.
🐍🍒⛏🤖

…types (pythonGH-103036) * add test for the predefined object's attributes * Include the "object" type in the lists of documented types * remove 'or' from augment tuple * 📜🤖 Added by blurb_it. * Add cross-reference to news Co-authored-by: C.A.M. Gerlach <[email protected]> * Fix format for the function parameter Co-authored-by: C.A.M. Gerlach <[email protected]> * Add space Co-authored-by: C.A.M. Gerlach <[email protected]> * add reference for the 'object' Co-authored-by: C.A.M. Gerlach <[email protected]> * add reference for NotImplemented Co-authored-by: C.A.M. Gerlach <[email protected]> * Change ref:`string <textseq>` as class:`str` Co-authored-by: C.A.M. Gerlach <[email protected]> * remove hyphen from `newly-created` * Update Doc/reference/datamodel.rst 'dictionaries' to 'dict' Co-authored-by: C.A.M. Gerlach <[email protected]> * Update predefined attribute types in testPredefinedAttrs * Change `universal type` as `top type` * Don't mention about the top type * Update the description of richcmpfuncs * Update Doc/library/stdtypes.rst Co-authored-by: Éric <[email protected]> * Revert: Hierarchy Section in Data Model Documentation * Revert to original explanations of __new__ and __init__ methods in datamodel.rst for improved clarity. * Update Doc/reference/datamodel.rst Co-authored-by: Éric <[email protected]> * Remove blank line Co-authored-by: Éric <[email protected]> * Use ref:`str <textseq>` instead of :class:`str Co-authored-by: Éric <[email protected]> * Revert changes the description of Other Built-in Types in stdtypes.rst * Update Doc/reference/datamodel.rst Co-authored-by: Éric <[email protected]> --------- (cherry picked from commit 4f82621) Co-authored-by: Furkan Onder <[email protected]> Co-authored-by: blurb-it[bot] <43283697+blurb-it[bot]@users.noreply.github.com> Co-authored-by: C.A.M. Gerlach <[email protected]> Co-authored-by: Terry Jan Reedy <[email protected]> Co-authored-by: Éric <[email protected]> Co-authored-by: Carol Willing <[email protected]>

bedevere-app · 2024-10-30T18:20:24Z

GH-126197 is a backport of this pull request to the 3.13 branch.

bedevere-app · 2024-10-30T18:20:30Z

GH-126198 is a backport of this pull request to the 3.12 branch.

… types (GH-103036) (GH-126198) gh-60712: Include the "object" type in the lists of documented types (GH-103036) * add test for the predefined object's attributes * Include the "object" type in the lists of documented types * remove 'or' from augment tuple * 📜🤖 Added by blurb_it. * Add cross-reference to news * Fix format for the function parameter * Add space * add reference for the 'object' * add reference for NotImplemented * Change ref:`string <textseq>` as class:`str` * remove hyphen from `newly-created` * Update Doc/reference/datamodel.rst 'dictionaries' to 'dict' * Update predefined attribute types in testPredefinedAttrs * Change `universal type` as `top type` * Don't mention about the top type * Update the description of richcmpfuncs * Update Doc/library/stdtypes.rst * Revert: Hierarchy Section in Data Model Documentation * Revert to original explanations of __new__ and __init__ methods in datamodel.rst for improved clarity. * Update Doc/reference/datamodel.rst * Remove blank line * Use ref:`str <textseq>` instead of :class:`str * Revert changes the description of Other Built-in Types in stdtypes.rst * Update Doc/reference/datamodel.rst --------- (cherry picked from commit 4f82621) Co-authored-by: Furkan Onder <[email protected]> Co-authored-by: blurb-it[bot] <43283697+blurb-it[bot]@users.noreply.github.com> Co-authored-by: C.A.M. Gerlach <[email protected]> Co-authored-by: Terry Jan Reedy <[email protected]> Co-authored-by: Éric <[email protected]> Co-authored-by: Carol Willing <[email protected]>

… types (GH-103036) (GH-126197) gh-60712: Include the "object" type in the lists of documented types (GH-103036) * add test for the predefined object's attributes * Include the "object" type in the lists of documented types * remove 'or' from augment tuple * 📜🤖 Added by blurb_it. * Add cross-reference to news * Fix format for the function parameter * Add space * add reference for the 'object' * add reference for NotImplemented * Change ref:`string <textseq>` as class:`str` * remove hyphen from `newly-created` * Update Doc/reference/datamodel.rst 'dictionaries' to 'dict' * Update predefined attribute types in testPredefinedAttrs * Change `universal type` as `top type` * Don't mention about the top type * Update the description of richcmpfuncs * Update Doc/library/stdtypes.rst * Revert: Hierarchy Section in Data Model Documentation * Revert to original explanations of __new__ and __init__ methods in datamodel.rst for improved clarity. * Update Doc/reference/datamodel.rst * Remove blank line * Use ref:`str <textseq>` instead of :class:`str * Revert changes the description of Other Built-in Types in stdtypes.rst * Update Doc/reference/datamodel.rst --------- (cherry picked from commit 4f82621) Co-authored-by: Furkan Onder <[email protected]> Co-authored-by: blurb-it[bot] <43283697+blurb-it[bot]@users.noreply.github.com> Co-authored-by: C.A.M. Gerlach <[email protected]> Co-authored-by: Terry Jan Reedy <[email protected]> Co-authored-by: Éric <[email protected]> Co-authored-by: Carol Willing <[email protected]>

…types (pythonGH-103036) * add test for the predefined object's attributes * Include the "object" type in the lists of documented types * remove 'or' from augment tuple * 📜🤖 Added by blurb_it. * Add cross-reference to news Co-authored-by: C.A.M. Gerlach <[email protected]> * Fix format for the function parameter Co-authored-by: C.A.M. Gerlach <[email protected]> * Add space Co-authored-by: C.A.M. Gerlach <[email protected]> * add reference for the 'object' Co-authored-by: C.A.M. Gerlach <[email protected]> * add reference for NotImplemented Co-authored-by: C.A.M. Gerlach <[email protected]> * Change ref:`string <textseq>` as class:`str` Co-authored-by: C.A.M. Gerlach <[email protected]> * remove hyphen from `newly-created` * Update Doc/reference/datamodel.rst 'dictionaries' to 'dict' Co-authored-by: C.A.M. Gerlach <[email protected]> * Update predefined attribute types in testPredefinedAttrs * Change `universal type` as `top type` * Don't mention about the top type * Update the description of richcmpfuncs * Update Doc/library/stdtypes.rst Co-authored-by: Éric <[email protected]> * Revert: Hierarchy Section in Data Model Documentation * Revert to original explanations of __new__ and __init__ methods in datamodel.rst for improved clarity. * Update Doc/reference/datamodel.rst Co-authored-by: Éric <[email protected]> * Remove blank line Co-authored-by: Éric <[email protected]> * Use ref:`str <textseq>` instead of :class:`str Co-authored-by: Éric <[email protected]> * Revert changes the description of Other Built-in Types in stdtypes.rst * Update Doc/reference/datamodel.rst Co-authored-by: Éric <[email protected]> --------- Co-authored-by: blurb-it[bot] <43283697+blurb-it[bot]@users.noreply.github.com> Co-authored-by: C.A.M. Gerlach <[email protected]> Co-authored-by: Terry Jan Reedy <[email protected]> Co-authored-by: Éric <[email protected]> Co-authored-by: Carol Willing <[email protected]>

merwok · 2025-02-05T18:10:05Z

The commit message was not trimmed, and github for some unfathomable reason defaults to concatenating the messages of all commits in the PR.

I use a browser extension Refined Github to avoid this, and now there is also a repo setting to change the default merge commit message: I don’t have the time to start a discussion on the forums, but I’m leaving the idea here for someone.

furkanonder added 2 commits March 25, 2023 23:53

add test for the predefined object's attributes

2c09057

Include the "object" type in the lists of documented types

9a71e36

bedevere-bot added the tests Tests in the Lib/test dir label Mar 25, 2023

bedevere-bot mentioned this pull request Mar 25, 2023

Include the "object" type in the lists of documented types #60712

Closed

bedevere-bot added the awaiting review label Mar 25, 2023

Eclips4 reviewed Mar 25, 2023

View reviewed changes

Lib/test/test_class.py Outdated Show resolved Hide resolved

furkanonder and others added 2 commits March 29, 2023 00:52

remove 'or' from augment tuple

d327409

📜🤖 Added by blurb_it.

73698a5

furkanonder requested a review from Eclips4 March 29, 2023 14:46

terryjreedy requested review from vadmium and removed request for Eclips4 March 29, 2023 17:56

CAM-Gerlach added the docs Documentation in the Doc dir label Mar 29, 2023

CAM-Gerlach reviewed Mar 29, 2023

View reviewed changes

merwok reviewed Mar 29, 2023

View reviewed changes

Doc/reference/datamodel.rst Outdated Show resolved Hide resolved

Doc/reference/datamodel.rst Outdated Show resolved Hide resolved

furkanonder and others added 5 commits March 30, 2023 12:48

Add cross-reference to news

1064065

Co-authored-by: C.A.M. Gerlach <[email protected]>

Fix format for the function parameter

ce4d192

Co-authored-by: C.A.M. Gerlach <[email protected]>

Add space

aca2c04

Co-authored-by: C.A.M. Gerlach <[email protected]>

add reference for the 'object'

f6c12d8

Co-authored-by: C.A.M. Gerlach <[email protected]>

add reference for NotImplemented

b1ab4a2

Co-authored-by: C.A.M. Gerlach <[email protected]>

Jacob-Flasheye reviewed Mar 30, 2023

View reviewed changes

Doc/library/functions.rst Show resolved Hide resolved

furkanonder and others added 3 commits April 1, 2023 01:12

Change ref:string <textseq> as class:str

d709946

Co-authored-by: C.A.M. Gerlach <[email protected]>

remove hyphen from newly-created

105f331

Update Doc/reference/datamodel.rst

119e29b

'dictionaries' to 'dict' Co-authored-by: C.A.M. Gerlach <[email protected]>

terryjreedy self-assigned this Jun 18, 2023

terryjreedy previously requested changes Jun 18, 2023

View reviewed changes

bedevere-bot added awaiting changes and removed awaiting review labels Jun 18, 2023

furkanonder changed the title ~~GH-60712: Include the "object" type in the lists of documented types~~ gh-60712: Include the "object" type in the lists of documented types Aug 6, 2023