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

Misleading self doc strings and poor self documentation #14

Open
GoogleCodeExporter opened this issue Mar 21, 2015 · 0 comments
Open

Misleading self doc strings and poor self documentation #14

GoogleCodeExporter opened this issue Mar 21, 2015 · 0 comments

Comments

@GoogleCodeExporter
Copy link

I looked for an option to pass user defined name server (via adns.init) and it 
took to me some time to understand following:

1. debugfileobj is file handler like: open('/tmp/adns.log', 'a'). This was hard 
to figure out, as python interpreter return some bullshit like: 'TypeError: 
must be (unspecified), not str'. 
Only looking at module sources made to understand to pass file handler.
2. configtext is text in resolv.conf format like: 'nameserver 8.8.8.8'
3. Also there is a typo in doc string, as arguments wrapped in a list...
Incorrect (current) - s.adns.init([initflags,debugfileobj=stderr,configtext=''])
Correct - adns.init(initflags,debugfileobj=stderr,configtext='')




Original issue reported on code.google.com by 0x6d3...@gmail.com on 15 Nov 2014 at 1:28

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

1 participant