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

Fix the docstrings for return info #5

Open
tylercrompton opened this issue Jun 22, 2021 · 3 comments
Open

Fix the docstrings for return info #5

tylercrompton opened this issue Jun 22, 2021 · 3 comments
Labels
enhancement good first issue
Milestone
First Release

Comments

@tylercrompton
Copy link
Owner

Modify the docstrings such that they use the rST directive :return:.
@tylercrompton tylercrompton self-assigned this Jun 22, 2021
@tylercrompton tylercrompton removed their assignment Jun 28, 2021
@tylercrompton tylercrompton mentioned this issue Jul 25, 2021
Open
@tylercrompton tylercrompton self-assigned this Jul 25, 2021
@tylercrompton
Copy link
Owner Author

tylercrompton commented Jul 25, 2021 •
edited
Loading

And :rtype:

@tylercrompton tylercrompton added this to the First Release milestone Oct 3, 2021
@tylercrompton
Copy link
Owner Author

Actually, don't bother with :rtype:. See #11. We won't be putting type information in the docstrings.

@tylercrompton
Copy link
Owner Author

tylercrompton commented Oct 3, 2021 •
edited
Loading

We're going to use the Google docstring style guide, so I would prefer that we close #9 before starting this one, as that would result in the least amount of work, but I think that this one is also more important than #9, so it can go either way.

@tylercrompton tylercrompton removed their assignment Oct 3, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
enhancement good first issue
Projects
None yet
Milestone
First Release
Development

No branches or pull requests
1 participant
@tylercrompton