Docs: add author data to modules

[GoogleCodeExporter]

The following modules need author data:

all weights modules
econometrics.classic
pysal.FileIO

Original issue reported on code.google.com by phil.stp...@gmail.com on 8 Mar 2010 at 5:22

[GoogleCodeExporter]

Original comment by sjsrey on 20 Mar 2010 at 6:03

• Added labels: Milestone-1.0

[GoogleCodeExporter]

We still need author data in the following modules:

weights/spatial_lag.py
core/FileIO.py

Implementation is not consistent. In some cases, it's __authors__ = ... and in 
others, Author(s):

Original comment by phil.stp...@gmail.com on 6 Apr 2010 at 9:22

• Changed state: Started

[GoogleCodeExporter]

Original comment by phil.stp...@gmail.com on 6 Apr 2010 at 9:23

• Added labels: Type-Enhancement
• Removed labels: Type-Defect

[GoogleCodeExporter]

Original comment by phil.stp...@gmail.com on 6 Apr 2010 at 9:24

• Added labels: Priority-Low
• Removed labels: Priority-Medium

[GoogleCodeExporter]

Django uses a single AUTHORS file a the root of the project.  Is this something 
we've considered?

Original comment by schmi...@gmail.com on 6 Apr 2010 at 9:31

[GoogleCodeExporter]

Original comment by sjsrey on 4 May 2010 at 5:53

[GoogleCodeExporter]

I have poked around the internet and found no single convention for how to 
identify authors of a Python module.  
I am going to go with my interpretation of a nine year old Guido quote and 
implement the following:

__author__ = "John Q. Public <jpublic@gmail.com>"
or
__author__ = "John Q. Public <jpublic@gmail.com>, Jane Doe <jdoe@gmail.com>"

See below if you want the justification...

This thread has a lengthy discussion on the matter. But no resolution.
http://www.velocityreviews.com/forums/t336433-__author__.html

A couple of comments from Guido on the matter from 2001...
-Here he says it's okay to use __version__.  He also talks about listing 
authors.
--http://www.python.org/dev/peps/pep-0008/
-Here is a list serve posting from Guido. 
--He is initially luke warm on the idea of __something__ variables.
---http://mail.python.org/pipermail/python-dev/2001-March/013328.html
--He then warms up to the idea (slightly) after getting more info:
---http://mail.python.org/pipermail/python-dev/2001-March/013331.html

This guy likes it too:
http://bayes.colorado.edu/PythonGuidelines.html

Original comment by dfo...@gmail.com on 5 May 2010 at 10:19

[GoogleCodeExporter]

I have checked the three modules I have (co)authored for author documentation 
format.
/weights/Wsets.py
/region/randomregion.py
/region/maxp.py

Passing to Andrew.

Original comment by dfo...@gmail.com on 5 May 2010 at 11:08

[GoogleCodeExporter]

i don't think andrew is currently working on pysal (andrew if you are we can 
pass this ticket to you later). 
continuing on alphabetically it goes to cs

Original comment by sjsrey on 6 May 2010 at 4:25

[GoogleCodeExporter]

Original comment by phil.stp...@gmail.com on 6 May 2010 at 5:24

• Changed title: Docs: add author data to modules

[GoogleCodeExporter]

Filled out most of Core. Sending to Dani (next on the list)

Original comment by schmi...@gmail.com on 26 Jul 2010 at 4:11

[GoogleCodeExporter]

I've helped mostly on documentation external to the docstrings, so no real code 
contributions may be attributed to myself. 

'df' already filled in (comment 8 above), handing it next to Xinyue (xy).

Original comment by dreamessence on 28 Jul 2010 at 2:23

[GoogleCodeExporter]

Original comment by sjsrey on 31 Jul 2010 at 2:12

• Changed state: Done