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

Update Python Docstrings #38

Merged
merged 3 commits into from
Nov 13, 2020
Merged

Update Python Docstrings #38

merged 3 commits into from
Nov 13, 2020

Conversation

PhillSimonds
Copy link
Contributor

@PhillSimonds PhillSimonds commented Nov 13, 2020 •
edited
Loading

This PR updates the doc-strings on all non-test functions to make them PEP 257 compliant.

@PhillSimonds PhillSimonds requested a review from dgarros November 13, 2020 16:44
glennmatthews
glennmatthews approved these changes Nov 13, 2020
View reviewed changes
Copy link
Contributor

@glennmatthews glennmatthews left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Personally I wouldn't have considered this to be a high-priority item, but looks good to me.

@PhillSimonds
Copy link
Contributor Author

PhillSimonds commented Nov 13, 2020 •
edited
Loading

Personally I wouldn't have considered this to be a high-priority item, but looks good to me.

Ack -- I was tackling it as part of the documentation per #7 which I think we were trying to achieve before merging devel-meet-reqs into master... But I agree, I should have prioritized other things over it.

dgarros
dgarros approved these changes Nov 13, 2020
View reviewed changes
Copy link
Contributor

@dgarros dgarros left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM too

@dgarros dgarros merged commit 6c8e776 into devel-meet-reqs Nov 13, 2020
@PhillSimonds PhillSimonds deleted the psi/update-gdocstrings branch November 13, 2020 20:47
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@glennmatthews glennmatthews glennmatthews approved these changes

@dgarros dgarros dgarros approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@PhillSimonds @dgarros @glennmatthews