classification
Title: doc bug: confusing table of values
Type: Stage: resolved
Components: Documentation Versions:
process
Status: closed Resolution: fixed
Dependencies: Superseder:
Assigned To: docs@python Nosy List: christian.heimes, docs@python, eli.bendersky, georg.brandl, python-dev, terry.reedy
Priority: normal Keywords:

Created on 2013-10-06 11:01 by georg.brandl, last changed 2013-10-12 16:19 by python-dev. This issue is now closed.

Messages (4)
msg199066 - (view) Author: Georg Brandl (georg.brandl) * (Python committer) Date: 2013-10-06 11:01
-----BEGIN PGP SIGNED MESSAGE-----
Hash: SHA1

[From Jason Scherer on docs@python.org]

On this page:

http://docs.python.org/2/library/xml.html

The table of truth values is a bit confusing because it's not clear from the
context what it's actually saying is true, or false.

It might be better to replace the words "true" and "false" with "vulnerable" and
"protected" or something like that.  Otherwise, I can't tell if "true" means
"yes, this parser is vulnerable to this attack" or if "true" means "yes, this
parser is protected from this attack"

-----BEGIN PGP SIGNATURE-----
Version: GnuPG v2.0.21 (GNU/Linux)

iEYEARECAAYFAlJRQ0IACgkQN9GcIYhpnLCziACeO3MzVKKcH8RLlU+w11hAy9Kh
wo4AnRYvAXuCCLdlrED2SHJ0oexW1vj0
=dxxa
-----END PGP SIGNATURE-----
msg199526 - (view) Author: Terry J. Reedy (terry.reedy) * (Python committer) Date: 2013-10-12 00:00
I agree that this could be improved. It took a few readings to convince myself that True == Vulnerable. (Assuming that this is correct ;-) the table needs a title like Vulernable or a lead in sentence: "The following table indicates which modules are susceptible to which attacks."  Since True and False are names of Python objects, I would also prefer Yes and No or X and <blank> or '-'.
msg199586 - (view) Author: Roundup Robot (python-dev) (Python triager) Date: 2013-10-12 16:19
New changeset 6b0ca3963ff1 by Georg Brandl in branch '3.3':
Closes #19179: make table of XML vulnerabilities clearer by using "everyday" booleans and explaining the table beforehand.
http://hg.python.org/cpython/rev/6b0ca3963ff1
msg199587 - (view) Author: Roundup Robot (python-dev) (Python triager) Date: 2013-10-12 16:19
New changeset 9aae58596349 by Georg Brandl in branch '2.7':
Closes #19179: make table of XML vulnerabilities clearer by using "everyday" booleans and explaining the table beforehand.
http://hg.python.org/cpython/rev/9aae58596349
History
Date User Action Args
2013-10-12 16:19:29python-devsetmessages: + msg199587
2013-10-12 16:19:21python-devsetstatus: open -> closed

nosy: + python-dev
messages: + msg199586

resolution: fixed
stage: resolved
2013-10-12 00:00:07terry.reedysetnosy: + terry.reedy, eli.bendersky
messages: + msg199526
2013-10-06 11:02:09georg.brandlsetnosy: + christian.heimes, docs@python

components: + Documentation
assignee: docs@python
2013-10-06 11:01:32georg.brandlcreate