search

pombreda / pysal

Automatically exported from code.google.com/p/pysal
Other
0 stars 0 forks source link

Docs: Check that all docstrings are complete #74

Closed GoogleCodeExporter closed 9 years ago

GoogleCodeExporter commented 9 years ago 
Task to be completed

Original issue reported on code.google.com by sjsrey on 4 May 2010 at 5:43

GoogleCodeExporter commented 9 years ago

Original comment by sjsrey on 5 May 2010 at 5:38

GoogleCodeExporter commented 9 years ago 
I have checked the three modules I have (co)authored.  All have complete 
docstrings.
/weights/Wsets.py
/region/randomregion.py
/region/maxp.py

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

GoogleCodeExporter commented 9 years ago 
I think we agreed to pass this by alphabetical order. Starting at the top is 
Andrew.

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

GoogleCodeExporter commented 9 years ago

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

GoogleCodeExporter commented 9 years ago 
i don't think andrew is actively working on pysal, so charlie is next

Original comment by sjsrey on 26 Jul 2010 at 11:56

GoogleCodeExporter commented 9 years ago 
This ticket is vague.  Docs strings seem to be present in all modules.  If 
there are specific doc strings in specific modules that need work please create 
unique tickets for those modules.  What does "complete" mean, I don't see any 
guidance in the developers guide. (I remember the discussion from a code 
sprint, but not the outcome. Was it written up somewhere?)

Original comment by schmi...@gmail.com on 31 Jul 2010 at 3:02

GoogleCodeExporter commented 9 years ago 
we were passing it on alphabetically so that each person looks at their own mods

Original comment by sjsrey on 31 Jul 2010 at 3:06

GoogleCodeExporter commented 9 years ago 
passing along in tickets is a bad idea as we've tried this on several now and 
things linger way to long. revisit in 1.1

Original comment by sjsrey on 31 Jul 2010 at 3:28

GoogleCodeExporter commented 9 years ago 
Make each doc string verbose

Original comment by sjsrey on 7 Jan 2011 at 9:37

GoogleCodeExporter commented 9 years ago

Original comment by sjsrey on 7 Jan 2011 at 9:39

GoogleCodeExporter commented 9 years ago 
The doctest examples need to be written with an eye towards more explanation of 
the snippets than we had in 1.0. Assume the audience is an end user (not a 
pysal developer) and explain any lines/blocks that would appear obscure to such 
a user

for an example see  
http://code.google.com/p/pysal/source/browse/trunk/pysal/spatial_dynamics/markov
.py?r=602#56

Let's work through this one developer at a time - check any modules you have 
prime responsibility on and make the changes if needed. Once done, pass the 
ticket on to the next person in the list:

Nick
Myunghwa
Phil
Dave
Serge
Charlie

Original comment by sjsrey on 18 Jan 2011 at 3:54

GoogleCodeExporter commented 9 years ago 
when you are done and passing it on, please send the next developer an email to 
give them a heads up of the newly assigned ticket

Original comment by sjsrey on 18 Jan 2011 at 3:57

GoogleCodeExporter commented 9 years ago 
Better example to follow: 
http://code.google.com/p/pysal/source/browse/trunk/pysal/spatial_dynamics/direct
ional.py#54

Original comment by sjsrey on 18 Jan 2011 at 4:10

GoogleCodeExporter commented 9 years ago 
Made changes to docs in interaction. Passing the ball to Myunghwa.

Original comment by nmali...@gmail.com on 18 Jan 2011 at 7:49

GoogleCodeExporter commented 9 years ago

Original comment by phil.stp...@gmail.com on 24 Jan 2011 at 7:32

GoogleCodeExporter commented 9 years ago 
Passing to Serge.

Original comment by dfo...@gmail.com on 28 Jan 2011 at 11:05

GoogleCodeExporter commented 9 years ago

Original comment by sjsrey on 13 Apr 2011 at 9:24