Created on 2008-01-02 18:31 by barry, last changed 2010-09-18 18:38 by BreamoreBoy.
| Messages (4) | |||
|---|---|---|---|
| msg59102 - (view) | Author: Barry A. Warsaw (barry) *  |
Date: 2008-01-02 18:33 | |
urllib.splithost() and .splittype() are included in urllib's __all__ but are not documented in urllib's module documentation. They are used quite extensively in the module so they should be documented |
|||
| msg59483 - (view) | Author: Georg Brandl (georg.brandl) * |
Date: 2008-01-07 19:22 | |
There are quite a lot more functions in __all__, more than 10 split* functions... should they all be documented? Also, isn't urlparse meant to do such tasks? |
|||
| msg59577 - (view) | Author: Senthil Kumaran (orsenthil) * |
Date: 2008-01-09 00:32 | |
> Georg Brandl added the comment: > > There are quite a lot more functions in __all__, more than 10 split* > functions... should they all be documented? > > Also, isn't urlparse meant to do such tasks? I agree. I too feel that not everything in the __all__ list should be documented. And in this specific case of splithost, it is more appropriate for the user to use urlparse. |
|||
| msg113210 - (view) | Author: Terry J. Reedy (terry.reedy) * |
Date: 2010-08-07 21:27 | |
When internal functions lack '_', perhaps the doc should say "xys,uie, and ooe are intentionally undocumented internal functions." Otherwise, how is one supposed to know? |
|||
| History | |||
|---|---|---|---|
| Date | User | Action | Args |
| 2010-09-18 18:38:01 | BreamoreBoy | set | assignee: georg.brandl -> docs@python nosy: + docs@python |
| 2010-08-07 21:27:40 | terry.reedy | set | nosy:
+ terry.reedy messages: + msg113210 versions: - Python 2.6 |
| 2010-01-17 07:26:00 | ezio.melotti | set | nosy:
+ ezio.melotti |
| 2010-01-15 22:06:16 | brian.curtin | set | keywords:
+ easy stage: needs patch type: enhancement versions: + Python 2.6, Python 3.1, Python 2.7, Python 3.2, - Python 2.5 |
| 2008-01-09 00:32:44 | orsenthil | set | nosy:
+ orsenthil messages: + msg59577 |
| 2008-01-07 19:22:09 | georg.brandl | set | messages: + msg59483 |
| 2008-01-02 18:47:22 | gvanrossum | set | assignee: georg.brandl nosy: + georg.brandl |
| 2008-01-02 18:33:00 | barry | set | messages: + msg59102 |
| 2008-01-02 18:31:39 | barry | create | |