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

Convert image_io docstrings to numpydoc style #43

Merged
merged 3 commits into from
Mar 6, 2024
Merged

Convert image_io docstrings to numpydoc style #43

merged 3 commits into from
Mar 6, 2024

Conversation

K-Meech
Copy link
Contributor

@K-Meech K-Meech commented Mar 5, 2024

This PR converts all docstrings in the image_io sub-module from reST style to numpydoc style

References

For #19

@K-Meech K-Meech requested a review from a team March 5, 2024 10:55
willGraham01
willGraham01 reviewed Mar 5, 2024
View reviewed changes
Copy link
Contributor

@willGraham01 willGraham01 left a comment •
edited
Loading

Choose a reason for hiding this comment

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

It's so readable 🥳 One thing on optional arguments, though I appreciate it's a bit of a pain to go through and add the word "optional" everywhere 😅

brainglobe_utils/image_io/load.py Outdated Show resolved Hide resolved
@willGraham01 willGraham01 self-requested a review March 6, 2024 11:48
@willGraham01 willGraham01 merged commit 17ff6f6 into main Mar 6, 2024
10 checks passed
@willGraham01 willGraham01 deleted the image_io_docstrings branch March 6, 2024 11:49
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@willGraham01 willGraham01 willGraham01 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.
2 participants
@K-Meech @willGraham01