search

andreiko / adns-python

Automatically exported from code.google.com/p/adns-python
0 stars 1 forks source link

Misleading self doc strings and poor self documentation #14

Open GoogleCodeExporter opened 9 years ago

GoogleCodeExporter commented 9 years ago 
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