From: "Michael Hudson" <mwh@python.net> > > Comment generously, the best modules are an education to read. > > This one I have mild issues with. Ideally, your code is so clear that > it requires no comments to read! And information for users of the > code should be in docstrings. If you're implementing a non-obvious > algorithm then there's a place for a comment block educating the > reader how it works, but I'm leery of anything that might seem to > encourage the "i = i + 1 # add one to i" This ought to be more clear: Reading heapq and timeit makes you smart -- let's comment like that. Raymond Hettinger
RetroSearch is an open source project built by @garambo | Open a GitHub Issue
Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo
HTML:
3.2
| Encoding:
UTF-8
| Version:
0.7.4