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

Updated docstring to google format. #12

Merged
merged 5 commits into from
Aug 31, 2023
Merged

Updated docstring to google format. #12

merged 5 commits into from
Aug 31, 2023

Conversation

dlpbc
Copy link
Contributor

@dlpbc dlpbc commented Aug 29, 2023

Updated two scripts from non-google style docstring to google style docstring.

@dlpbc
Updated docstring to google format.
48c1716 
Updated two scripts from non-google style docstring to google style docstring.
joseph-palmer
joseph-palmer suggested changes Aug 30, 2023
View reviewed changes
Copy link
Contributor

@joseph-palmer joseph-palmer left a comment

Choose a reason for hiding this comment

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

Nice, thanks for this!

I have suggested a few changes to the doc strings to make them more verbose. There are also some punctuation inconsistencies that need to be tidied up and previous styles left in that need to be removed.

@dlpbc
Copy link
Contributor Author

dlpbc commented Aug 31, 2023

Nice, thanks for this!

I have suggested a few changes to the doc strings to make them more verbose. There are also some punctuation inconsistencies that need to be tidied up and previous styles left in that need to be removed.

Thanks!
The code has been updated.

joseph-palmer
joseph-palmer approved these changes Aug 31, 2023
View reviewed changes
Copy link
Contributor

@joseph-palmer joseph-palmer left a comment

Choose a reason for hiding this comment

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

LGTM - Thank you for adopting the changes!

@dlpbc dlpbc merged commit 392bdfd into main Aug 31, 2023
5 checks passed
@dlpbc dlpbc deleted the fix_google_docstring_v2 branch August 31, 2023 19:02
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@joseph-palmer joseph-palmer joseph-palmer approved these changes

@Iain-S Iain-S Awaiting requested review from Iain-S

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

Successfully merging this pull request may close these issues.
2 participants
@dlpbc @joseph-palmer