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.

Title: OptionParser.allow_interspersed_args is undocumented
Type: Stage:
Components: Versions:
Status: closed Resolution: works for me
Dependencies: Superseder:
Assigned To: Nosy List: georg.brandl, r.david.murray, skip.montanaro, terry.reedy
Priority: normal Keywords:

Created on 2009-09-11 14:26 by skip.montanaro, last changed 2022-04-11 14:56 by admin. This issue is now closed.

Messages (6)
msg92510 - (view) Author: Skip Montanaro (skip.montanaro) * (Python triager) Date: 2009-09-11 14:26
The OptionParser.allow_interspersed_args attribute is undocumented in
the Sphinx documentation.  (It is mentioned in the OptionParser
docstring.)  By its name it appears to actually part of the official
API, so should at least be mentioned in the rst file.
msg92753 - (view) Author: Georg Brandl (georg.brandl) * (Python committer) Date: 2009-09-17 10:18
The (en|dis)able_interspersed_args accessors are already documented, so
I see no reason to document the attribute as well...
msg92777 - (view) Author: Skip Montanaro (skip.montanaro) * (Python triager) Date: 2009-09-17 16:17
Georg> The (en|dis)able_interspersed_args accessors are already
    Georg> documented, so I see no reason to document the attribute as
    Georg> well...

But it is documented in the class's docstring and there are no docstrings
for the methods.  It's not at all clear which is the "best" way to change
that particular behavior.

msg92778 - (view) Author: Georg Brandl (georg.brandl) * (Python committer) Date: 2009-09-17 16:21
The methods do have docstrings (trunk rev, line 1283 and 1291).

And usually, when there are accessors for a property, they are the
preferred way to change it.

Anyway, I don't see a reason to do something here, so please propose a
patch if you still think the docs inadequate.
msg104549 - (view) Author: Terry J. Reedy (terry.reedy) * (Python committer) Date: 2010-04-29 18:02
Skip, can we close this?
msg104561 - (view) Author: R. David Murray (r.david.murray) * (Python committer) Date: 2010-04-29 18:27
Since he hasn't proposed a patch, we close it :)

Skip can always reopen it if he wants.
Date User Action Args
2022-04-11 14:56:52adminsetgithub: 51132
2010-04-29 18:27:33r.david.murraysetstatus: open -> closed
nosy: + r.david.murray
messages: + msg104561

2010-04-29 18:02:28terry.reedysetstatus: pending -> open
nosy: + terry.reedy
messages: + msg104549

2009-09-17 16:21:58georg.brandlsetstatus: open -> pending

messages: + msg92778
2009-09-17 16:17:52skip.montanarosetstatus: pending -> open

messages: + msg92777
2009-09-17 10:18:31georg.brandlsetstatus: open -> pending

nosy: + georg.brandl
messages: + msg92753

resolution: works for me
2009-09-11 14:26:26skip.montanarocreate