Author dan.merillat
Recipients dan.merillat, docs@python
Date 2020-11-19.07:54:09
SpamBayes Score -1.0
Marked as misclassified Yes
Message-id <1605772450.46.0.534233134191.issue42402@roundup.psfhosted.org>
In-reply-to
Content
"The interpretation of the flags and the speeds as well as the indexing in the cc array must be done using the symbolic constants defined in the |termios| module."  (termios links to itself)

These constants are not listed in the documentation and the termios module is installed as a shared library so you can't read it without going to the source.

Furthermore the example in the documentation uses the following example:

new = termios.tcgetattr(fd)
new[3] = new[3] & ~termios.ECHO          # lflags

Which is explicitly against the documentation on the same page.
This has led to most searches on the net turning up people using magic numbers in places instead of symbolic values.

Inserting a list of constants with an extremely brief description would improve the module documentation dramatically.
History
Date User Action Args
2020-11-19 07:54:10dan.merillatsetrecipients: + dan.merillat, docs@python
2020-11-19 07:54:10dan.merillatsetmessageid: <1605772450.46.0.534233134191.issue42402@roundup.psfhosted.org>
2020-11-19 07:54:10dan.merillatlinkissue42402 messages
2020-11-19 07:54:09dan.merillatcreate