Skip to content

bpo-33869: Add link to list definition in Glossary list entry#7706

Closed
andresdelfino wants to merge 2 commits intopython:masterfrom
andresdelfino:add-sets-to-glossary
Closed

bpo-33869: Add link to list definition in Glossary list entry#7706
andresdelfino wants to merge 2 commits intopython:masterfrom
andresdelfino:add-sets-to-glossary

Conversation

@andresdelfino
Copy link
Copy Markdown
Contributor

@andresdelfino andresdelfino commented Jun 15, 2018

Comment thread Doc/glossary.rst Outdated
:func:`~abc.register`.

set
An unordered collection of distinct :term:`hashable` objects that eases
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Question: Although it would be handy for newcomers to know some usages of a set, should this be considered part of the definition?

I am refering to this part:

eases duplicate removal and computation of mathematical operations such as intersection and difference.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

That's a pretty good question, actually. It's hard to understand what actually is expected from a set type (not the specific set class) from the docs, as it's mostly mixed with set (class) and frozenset:

https://docs.python.org/3/library/stdtypes.html#set-types-set-frozenset

Perhaps this is something I should ask on python-dev ?

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks folks. Perhaps reorganizing a bit would help:

An unordered collection of distinct :term:`hashable` objects that were introduced in :pep:`218`.

Python provides two built-in set types: set (a :term:`mutable` type), and frozen set (an :term:`immutable` type). See :ref:`types-set`.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Because of Raymon's comment on the BPO issue, I modified the PR substantially, to the point that it only adds a link, actually 😅

@andresdelfino andresdelfino changed the title bpo-33869: Add set, frozen set, and tuple entries to Glossary bpo-33869: Add link to list definition in Glossary list entry Jun 17, 2018
@serhiy-storchaka serhiy-storchaka added docs Documentation in the Doc dir skip news labels Jul 7, 2018
@rhettinger
Copy link
Copy Markdown
Contributor

I don't see think typesseq link target as being particularly useful.

@rhettinger rhettinger closed this Jul 16, 2018
@andresdelfino andresdelfino deleted the add-sets-to-glossary branch July 16, 2018 11:06
@willingc
Copy link
Copy Markdown
Contributor

Though we didn't accept this PR, thanks for the PR @andresdelfino. I agree with @rhettinger on this particular change.

@andresdelfino You've been contributing for a while now 😄 It would be great to have you working on meatier doc issues if you would like.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

awaiting review docs Documentation in the Doc dir skip news

Projects

None yet

Development

Successfully merging this pull request may close these issues.

7 participants