This issue tracker has been migrated to GitHub, and is currently read-only.
For more information, see the GitHub FAQs in the Python's Developer Guide.

classification
Title: help() of bitwise operators should mention sets as well
Type: enhancement Stage:
Components: Documentation Versions: Python 3.7
process
Status: open Resolution:
Dependencies: Superseder:
Assigned To: docs@python Nosy List: docs@python, r.david.murray, steven.daprano
Priority: normal Keywords:

Created on 2017-12-23 04:35 by steven.daprano, last changed 2022-04-11 14:58 by admin.

Messages (2)
msg308946 - (view) Author: Steven D'Aprano (steven.daprano) * (Python committer) Date: 2017-12-23 04:35
If you ask for help on the set operators ^ & and | then help docs only talk about them as bitwise operators.

Since sets and frozensets are important, built-in types, the help should mention them as well.
msg308956 - (view) Author: R. David Murray (r.david.murray) * (Python committer) Date: 2017-12-23 16:24
Which help are you talking about?  The Operator Precedence table that you get if you do, eg: help('&')?  I don't think it would be appropriate to mention specialized uses of the operators there, although perhaps we could add a general note about operator overloading in the intro paragraph and use set as the example.  Looking at help('BITWISE'), we could add 'when the arguments are numbers' after the precedence table, but since that section is called 'bitwise' I don't think we even want to mention set there.  Did you have other sections in mind?
History
Date User Action Args
2022-04-11 14:58:56adminsetgithub: 76593
2017-12-23 16:24:04r.david.murraysetnosy: + r.david.murray
messages: + msg308956
2017-12-23 04:35:29steven.dapranocreate