[issue8653] urlparse.urlparse/urlsplit doc missing

New submission from Dave Abrahams <dave@boostpro.com>: The docstrings for these functions don't explain the 'scheme' parameter. Even renaming it to default_scheme would help. ---------- assignee: docs@python components: Documentation messages: 105221 nosy: dabrahams, docs@python priority: normal severity: normal status: open title: urlparse.urlparse/urlsplit doc missing _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue8653> _______________________________________

Changes by Dan Buch <daniel.buch@gmail.com>: ---------- nosy: +meatballhat _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue8653> _______________________________________

Senthil Kumaran <orsenthil@gmail.com> added the comment: I don't see anything that is missing. Its here in the docs http://docs.python.org/library/urlparse.html#urlparse-result-object And also docstrings has the information too. Could you explain a bit more as what you were expecting and found missing? ---------- assignee: docs@python -> orsenthil nosy: +orsenthil _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue8653> _______________________________________

Éric Araujo <merwok@netwok.org> added the comment: I think you mean http://docs.python.org/library/urlparse.html#urlparse.urlparse Dave, perhaps you were looking at an older version? Doc fixes for maintainance branches are welcome. ---------- nosy: +merwok _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue8653> _______________________________________

Dave Abrahams <dave@boostpro.com> added the comment: At Sat, 08 May 2010 22:18:13 +0000, Éric Araujo wrote:
No, I was looking at (and reporting on) the docstrings. ---------- _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue8653> _______________________________________

AdamN <adam@varud.com> added the comment: Maybe he's referring to the fact that 'default_scheme' is referenced in the docs but in fact the parameter name is 'scheme'? ---------- nosy: +adamnelson _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue8653> _______________________________________

AdamN <adam@varud.com> added the comment: The default_scheme issue I brought up has been fixed in #8818 ---------- _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue8653> _______________________________________

Éric Araujo <merwok@netwok.org> added the comment: Dave, can you explain your problem with a quote or a file name and line number, or directly propose a doc patch? ---------- _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue8653> _______________________________________

Senthil Kumaran <orsenthil@gmail.com> added the comment: Fixed in r82324, r82325, r82326, r82327. Only the urlunsplit need the docstrings, I added that. ---------- resolution: -> fixed stage: -> committed/rejected status: open -> closed _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue8653> _______________________________________

Changes by Dan Buch <daniel.buch@gmail.com>: ---------- nosy: +meatballhat _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue8653> _______________________________________

Senthil Kumaran <orsenthil@gmail.com> added the comment: I don't see anything that is missing. Its here in the docs http://docs.python.org/library/urlparse.html#urlparse-result-object And also docstrings has the information too. Could you explain a bit more as what you were expecting and found missing? ---------- assignee: docs@python -> orsenthil nosy: +orsenthil _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue8653> _______________________________________

Éric Araujo <merwok@netwok.org> added the comment: I think you mean http://docs.python.org/library/urlparse.html#urlparse.urlparse Dave, perhaps you were looking at an older version? Doc fixes for maintainance branches are welcome. ---------- nosy: +merwok _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue8653> _______________________________________

Dave Abrahams <dave@boostpro.com> added the comment: At Sat, 08 May 2010 22:18:13 +0000, Éric Araujo wrote:
No, I was looking at (and reporting on) the docstrings. ---------- _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue8653> _______________________________________

AdamN <adam@varud.com> added the comment: Maybe he's referring to the fact that 'default_scheme' is referenced in the docs but in fact the parameter name is 'scheme'? ---------- nosy: +adamnelson _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue8653> _______________________________________

AdamN <adam@varud.com> added the comment: The default_scheme issue I brought up has been fixed in #8818 ---------- _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue8653> _______________________________________

Éric Araujo <merwok@netwok.org> added the comment: Dave, can you explain your problem with a quote or a file name and line number, or directly propose a doc patch? ---------- _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue8653> _______________________________________

Senthil Kumaran <orsenthil@gmail.com> added the comment: Fixed in r82324, r82325, r82326, r82327. Only the urlunsplit need the docstrings, I added that. ---------- resolution: -> fixed stage: -> committed/rejected status: open -> closed _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue8653> _______________________________________
participants (5)
-
AdamN
-
Dan Buch
-
Dave Abrahams
-
Senthil Kumaran
-
Éric Araujo