[docs] [issue27409] List socket.SO_*, SCM_*, MSG_*, IPPROTO_* symbols
report at bugs.python.org
Tue Jun 28 22:54:56 EDT 2016
New submission from Martin Panter:
The documentation just says that SO_* etc constants are defined. However when people add new ones, they add them as new features to a specific version (not backported as bug fixes), but do not alter the documentation at all. IMO it is silly adding undocumented features. E.g. Issue 26907 was opened to add (among others) SO_PASSCRED, which was already added, undocumented, as part of Issue 6560.
This patch attempts to indicate which symbols are defined by Python (depending on OS availability), and therefore one can deduce if Python does not define a particular symbol. It could be adapted to the 2.7 documentation, but I am not really motivated for that on my own.
I also remove a redundant definition in the module, and removed a conditional because SO_REUSEADDR is required to always be defined according to the test suite. These specific changes should only be applied to 3.6.
I also found Issue 1732367, which has a patch documenting each AF_* symbol in a little more detail. That patch was never updated nor comitted, but it sounds like this kind of addition might be acceptable.
assignee: docs at python
nosy: docs at python, martin.panter
stage: patch review
title: List socket.SO_*, SCM_*, MSG_*, IPPROTO_* symbols
versions: Python 3.5, Python 3.6
Added file: http://bugs.python.org/file43573/socket-const.patch
Python tracker <report at bugs.python.org>
More information about the docs