search

iamLovingJerk / pychess

Automatically exported from code.google.com/p/pychess
GNU General Public License v3.0
0 stars 0 forks source link

Create __doc__ strings #89

Open GoogleCodeExporter opened 9 years ago

GoogleCodeExporter commented 9 years ago 
PyChess needs better documentation. It should be added by creating a
__doc__ string in most methods and functions, e.g.:
def function ():
   """ This is documentation
       This function does no good. """

Original issue reported on code.google.com by lobais on 21 Nov 2006 at 1:13

GoogleCodeExporter commented 9 years ago 
Any body should feel free to document any method, class or module they think 
they
have figured out.

Original comment by lobais on 29 Nov 2006 at 9:41

GoogleCodeExporter commented 9 years ago 
Couldn't agree more. It will make it more developer friendly and more open :). 
I see
how much I can understand of pychess' code without asking ;).

Original comment by wojciech.halicki.piszko on 15 Dec 2006 at 8:29

GoogleCodeExporter commented 9 years ago 
Btw., just read "Writing Code That Doesn't Suck"
http://ivory.idyll.org/blog/sep-07/not-sucking-v2
Don't you mind if i do some PEP8-ification in PyChess source sometimes?

Original comment by gbtami on 27 Sep 2007 at 7:23

GoogleCodeExporter commented 9 years ago 
Feel welcome.
Standardization is always good.
E.g. currently the functions are rather confused between theJavaWay and
the_pygtk_way. Personally I like theJavaWay the most, as 
the_pygtk_way.attributes are
harder to distinct because of the _/. similarity.

Original comment by lobais on 27 Sep 2007 at 12:34

GoogleCodeExporter commented 9 years ago 
This may be a good way to learn the code.

Original comment by G.nius...@gmail.com on 27 Jun 2013 at 3:18