Document Python Methods w/ proper docstrings.

cristian-bicheru / fast-ta

Python Technical Analysis Library For Big Data

https://fast-ta.readthedocs.io/en/latest/index.html

MIT License

10 stars 4 forks source link

Document Python Methods w/ proper docstrings. #4

Open CalderWhite opened 4 years ago

CalderWhite commented 4 years ago

We have decided to use Google-style docstrings for the python methods. More information on their standards here: http://google.github.io/styleguide/pyguide.html#38-comments-and-docstrings

CalderWhite commented 4 years ago

We have to remember that the RSI function can give poor results when too many threads are used on a small dataset. A note about this should be put in the docstring of RSI as a sort of "Buyer Beware".