Docstrings part 2 - Githubissues

timothyas / xesn

Large scale Echo State Networks powered by xarray and dask.

https://xesn.readthedocs.io

Apache License 2.0

1 stars 1 forks source link

Closed timothyas closed 11 months ago

timothyas commented 1 year ago

Finalize some stuff from last time:

[x] Decide if we want RandomMatrix, XData, etc to show up
[x] Make sure what is there (e.g., methods, attributes) is representative for the user.
[x] Determine best way to document attributes ... at top of class? What is the PEP way?

timothyas commented 1 year ago

Mostly taken care of in #58, need to polish off relevant docstrings with the documentation added with #23