Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Document Python Methods w/ proper docstrings. #4

Open
CalderWhite opened this issue Apr 15, 2020 · 1 comment
Open

Document Python Methods w/ proper docstrings. #4

CalderWhite opened this issue Apr 15, 2020 · 1 comment
Labels
documentation Improvements or additions to documentation
Projects
v0.2.0

Comments

@CalderWhite
Copy link
Collaborator

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 CalderWhite created this issue from a note in v0.2.0 (To Do) Apr 15, 2020
@CalderWhite
Copy link
Collaborator Author

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".

@CalderWhite CalderWhite added the documentation Improvements or additions to documentation label Apr 15, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
documentation Improvements or additions to documentation
Projects
v0.2.0
  
To Do
Milestone
No milestone
Development

No branches or pull requests
1 participant
@CalderWhite