[yt-dev] Issue #1100: [experimental] docstrings for all outward facing VR classes/functions (yt_analysis/yt)

Cameron Hummels issues-reply at bitbucket.org
Tue Oct 13 20:58:40 PDT 2015


New issue 1100: [experimental] docstrings for all outward facing VR classes/functions
https://bitbucket.org/yt_analysis/yt/issues/1100/experimental-docstrings-for-all-outward

Cameron Hummels:

Docstrings for all outward facing functions and classes including a description, parameters, returned quantities, and an example in the docstrings.  

right now, many examples are so trivial so as to not be helpful at all: 


```
#!python

source = PointsSource(particle_positions)

```

examples would be better served to be a full VR with the appropriate method/class injected; probably 3-5lines each; then can be tested with docstring tests down the road too.





More information about the yt-dev mailing list