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.

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

Add Docstrings #19

Closed
gran4 opened this issue Jun 23, 2023 · 3 comments · Fixed by #33
Closed

Add Docstrings #19

gran4 opened this issue Jun 23, 2023 · 3 comments · Fixed by #33
Labels
documentation Improvements or additions to documentation enhancement New feature or request good first issue Good for newcomers

Comments

@gran4
Copy link
Owner

gran4 commented Jun 23, 2023

No description provided.

@gran4 gran4 added the documentation Improvements or additions to documentation label Jun 23, 2023
@caidol
Copy link
Contributor

caidol commented Jun 25, 2023

Hello, I found this issue by filtering through Github's issue list as this is my very first time at trying to find an open source contribution to make.

Do I need to first authorise this contribution or can I simply create a fork and create a pull request with the added docstrings?

One more thing as well is that if I am allowed to contribute are there any specific rules about which files you want me to add the docstrings to and how they should be structured?

Thanks

@gran4
Copy link
Owner Author

gran4 commented Jun 25, 2023

You can just create a fork and a PR with the added docstrings. You can add them to all the files, but I recommend that you do them on the files under the main folder and not the tests.(Also, module docstrings would be helpful). They should be in Google style.

Also, I recommend doing it in multiple PR to make it easier to review. This will quicken the time it take to merge the PR.

Thank you

@gran4 gran4 added good first issue Good for newcomers enhancement New feature or request labels Jun 25, 2023
@gran4
Copy link
Owner Author

gran4 commented Jun 26, 2023

Also, could you star the repository so more people can see it?
Thank you a ton again.

gran4 pushed a commit that referenced this issue Jun 28, 2023
#31)

* Added docstrings to info and resource (#19)

* Fixed docstring requests #19

* Changed different case uses on 'list' #19
gran4 pushed a commit that referenced this issue Jun 28, 2023
* Added docstrings to trading modules (#19)

* Fixes requests for #19
gran4 pushed a commit that referenced this issue Jun 28, 2023
* Added docstrings to Model.py (#19)

* Fixed model docstring requests #19
@gran4 gran4 closed this as completed in #33 Jun 29, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation enhancement New feature or request good first issue Good for newcomers
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants