classification
Title: urllib.splituser is not documented
Type: Stage: committed/rejected
Components: Documentation Versions: Python 3.3, Python 3.2, Python 2.7
process
Status: closed Resolution: wont fix
Dependencies: Superseder:
Assigned To: orsenthil Nosy List: docs@python, orsenthil, sandro.tosi, techtonik
Priority: normal Keywords:

Created on 2011-01-25 20:24 by techtonik, last changed 2011-03-11 10:55 by orsenthil. This issue is now closed.

Messages (4)
msg127047 - (view) Author: anatoly techtonik (techtonik) Date: 2011-01-25 20:24
I'm studying old code that uses urllib.splituser() call and can't find description of this function in Python 2.6.6 docs.
msg130551 - (view) Author: Senthil Kumaran (orsenthil) * (Python committer) Date: 2011-03-11 09:25
splituser is an internal API. It has never been exposed through Docs anytime and there are good reasons for that too. We never want internal helper functions (even tough they don't startwith _) be exposed through docs as it may clutter the API Documentation. 

If you find a good use for splituser like function, it would good to discuss and build upon current one before exposing. 

I am closing this as wontfix.
msg130553 - (view) Author: Sandro Tosi (sandro.tosi) * (Python committer) Date: 2011-03-11 09:53
Hi Senthil,
what do you think about "documenting" those methods are private ones in the urllib code (if not using _, at least a short comment above them)? at least we have a mark it's an implementation decision and in case someone has the crazy idea :) to scan the module to fill in the missing methods in the doc, he'd know they are not to be exposed.
msg130558 - (view) Author: Senthil Kumaran (orsenthil) * (Python committer) Date: 2011-03-11 10:55
Sandro, I don't think is a required. Those functions serve the purpose
of making the module code modular. They are helper functions for the
module and are not really useful outside of it, when used standalone.
Think about , splituser, splitpath, splitport etc etc. 
I think, it is best that they remain as such, undocumented.
History
Date User Action Args
2011-03-11 10:55:17orsenthilsetnosy: orsenthil, techtonik, sandro.tosi, docs@python
messages: + msg130558
2011-03-11 09:53:17sandro.tosisetnosy: orsenthil, techtonik, sandro.tosi, docs@python
messages: + msg130553
2011-03-11 09:25:22orsenthilsetstatus: open -> closed

assignee: docs@python -> orsenthil

nosy: + orsenthil
messages: + msg130551
resolution: wont fix
stage: committed/rejected
2011-03-08 21:22:06sandro.tosisetnosy: + sandro.tosi

versions: + Python 2.7, Python 3.2, Python 3.3, - Python 2.6
2011-01-25 20:24:37techtonikcreate