search

SpatioTemporal / pystare

The Python interface for the SpatioTemporal Adaptive Resolution Encoding (STARE), a unified indexing for geolocated data.
https://pystare.readthedocs.io/en/latest/
12 stars 2 forks source link

complete docstrings #52

Open NiklasPhabian opened 3 years ago

NiklasPhabian commented 3 years ago

@michaelleerilee I am adding docstrings including usage to all functions I am at least 90 % sure of what they do. I add docstring stubs to all functions. If you ever find the time, could you supplement the docstrings. This only regards the two modules pystare/spatial.py and pystare/temporal.py

michaelleerilee commented 3 years ago

This is on branch refactor?

NiklasPhabian commented 3 years ago

yes. And not fully relevant yet. I am still working through temporal. This is more of a reminder for us two for later.

NiklasPhabian commented 3 years ago

As soon as I have sphinx set up (sometime tomorrow) and we can build the documentation, it will become embarrassingly obvious which methods will need docstrings. Let's talk then :)

NiklasPhabian commented 3 years ago

@michaelleerilee I am curious if you will be able to build the documentation now. run `make html in the docs/ director ... there probably will be a few packages missing for you though.

pip install sphinx-markdown-tables sphinx-automodapi myst_parser nbsphinx numpydoc pydata-sphinx-theme