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 #535

Open
1 task done
haxdds opened this issue Nov 30, 2021 · 0 comments
Open
1 task done

Add Docstrings #535

haxdds opened this issue Nov 30, 2021 · 0 comments
Labels
good first issue Good for newcomers

Comments

@haxdds
Copy link
Contributor

haxdds commented Nov 30, 2021

Is there an existing issue for this?

  • I have searched the existing issues

Is your feature request related to a problem? Please describe.

Having docstrings for all methods and classes will help new contributors understand the codebase and also provide a method of autogenerated API docs. Right now only some methods and classes have docstrings.

Describe the solution you'd like.

Example of already implemented docstring.

def get_aggs(self,
                 symbol: str,
                 multiplier: int,
                 timespan: str,
                 _from: str,
                 to: str) -> Aggs:
        """
        :param symbol: str eg AAPL
        :param multiplier: must be 1
        :param timespan: day or minute
        :param _from: yyyy-mm-dd
        :param to: yyyy-mm-dd
        :return:
        """
        resp = self.data_get('/aggs/ticker/{}/range/{}/{}/{}/{}'.format(
            symbol, multiplier, timespan, _from, to
        ))
        return self.response_wrapper(resp, Aggs)

Describe an alternate solution.

No response

Anything else? (Additional Context)

No response

@haxdds haxdds added the good first issue Good for newcomers label Nov 30, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
good first issue Good for newcomers
Projects
None yet
Development

No branches or pull requests

1 participant