Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

urllib2.getproxies not documented #49725

Closed
timmie mannequin opened this issue Mar 11, 2009 · 4 comments
Closed

urllib2.getproxies not documented #49725

timmie mannequin opened this issue Mar 11, 2009 · 4 comments
Assignees
@orsenthil
Labels
docs Documentation in the Doc dir

Comments

@timmie
Copy link
Mannequin

timmie mannequin commented Mar 11, 2009

BPO 5475
Nosy @birkenfeld, @orsenthil, @ned-deily, @merwok

Note: these values reflect the state of the issue at the time it was migrated and might not reflect the current state.

Show more details

GitHub fields:

assignee = 'https://github.com/orsenthil'
closed_at = <Date 2010-02-26.00:57:16.823>
created_at = <Date 2009-03-11.10:14:54.611>
labels = ['docs']
title = 'urllib2.getproxies not documented'
updated_at = <Date 2010-02-26.00:57:16.821>
user = 'https://bugs.python.org/timmie'

bugs.python.org fields:

activity = <Date 2010-02-26.00:57:16.821>
actor = 'orsenthil'
assignee = 'orsenthil'
closed = True
closed_date = <Date 2010-02-26.00:57:16.823>
closer = 'orsenthil'
components = ['Documentation']
creation = <Date 2009-03-11.10:14:54.611>
creator = 'timmie'
dependencies = []
files = []
hgrepos = []
issue_num = 5475
keywords = []
message_count = 4.0
messages = ['83464', '94154', '94198', '100131']
nosy_count = 5.0
nosy_names = ['georg.brandl', 'orsenthil', 'ned.deily', 'eric.araujo', 'timmie']
pr_nums = []
priority = 'normal'
resolution = 'fixed'
stage = None
status = 'closed'
superseder = None
type = None
url = 'https://bugs.python.org/issue5475'
versions = ['Python 2.6']
@timmie
Copy link
Mannequin Author

timmie mannequin commented Mar 11, 2009

There is no documentation for the function

in
http://docs.python.org/search.html?q=getproxies&check_keywords=yes&area=default

But the docstring shows:
ul.getproxies?
Type: function
Base Class: <type 'function'>
String Form: <function getproxies at 0x01096EF0>
Namespace: Interactive
File: c:\programme\pythonxy\python\lib\urllib.py
Definition: ul.getproxies()
Docstring:
Return a dictionary of scheme -> proxy server URL mappings.

Returns settings gathered from the environment, if specified,
or the registry.

@timmie timmie mannequin assigned birkenfeld Mar 11, 2009
@timmie timmie mannequin added the docs Documentation in the Doc dir label Mar 11, 2009
@ned-deily
Copy link
Member

In Python 2, urllib2.getproxies is one of a number of helper functions
imported from urllib. It's not externally documented there, either, and
likely not intended to be used externally.

@orsenthil
Copy link
Member

getproxies is urllib one of the many helper functions that is not
documented in the Documentation files.

I am not sure of a good resolution for this (leave it as such/Document
it/ make it private). I shall look into the test coverage,usage of the
function and decide.

@orsenthil orsenthil assigned orsenthil and unassigned birkenfeld Oct 18, 2009
@orsenthil
Copy link
Member

urllib.getproxies() might be helpful to be documented too. I have added documentaion to this helper function in the r78457 (trunk), r78458, r78459, r78460.

@ezio-melotti ezio-melotti transferred this issue from another repository Apr 10, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@orsenthil orsenthil

Labels
docs Documentation in the Doc dir
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
3 participants
@birkenfeld @orsenthil @ned-deily