Skip to content

2687 2688 Enhance doc-strings of Affine related transforms #2693

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
Merged
merged 9 commits into from
Aug 4, 2021
Merged

2687 2688 Enhance doc-strings of Affine related transforms #2693

merged 9 commits into from
Aug 4, 2021

Conversation

Nic-Ma
Copy link
Contributor

@Nic-Ma Nic-Ma commented Aug 4, 2021 •
edited by wyli
Loading

Fixes #2687
Fixes #2688 .

Description

This PR enhanced doc-strings of all the Affine matrix related transforms according to feedback.

Status

Ready

Types of changes

  • Non-breaking change (fix or new feature that would not break existing functionality).
  • Breaking change (fix or new feature that would cause existing functionality to change).
  • New tests added to cover the changes.
  • Integration tests passed locally by running ./runtests.sh -f -u --net --coverage.
  • Quick tests passed locally by running ./runtests.sh --quick --unittests.
  • In-line docstrings updated.
  • Documentation updated, tested make html command in the docs/ folder.

@Nic-Ma Nic-Ma requested review from wyli, rijobro, ericspod and yiheng-wang-nv and removed request for wyli August 4, 2021 04:04
yiheng-wang-nv
yiheng-wang-nv approved these changes Aug 4, 2021
View reviewed changes
Copy link
Contributor

@yiheng-wang-nv yiheng-wang-nv left a comment

Choose a reason for hiding this comment

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

Thanks! I suggest we add the link of this tutorial in the docstring. It may be helpful for users to decide what kind of values are suitable to choose.

wyli
wyli approved these changes Aug 4, 2021
View reviewed changes
Copy link
Contributor

@wyli wyli left a comment

Choose a reason for hiding this comment

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

Thank!

@Nic-Ma
Copy link
Contributor Author

Nic-Ma commented Aug 4, 2021

/black

@Nic-Ma Nic-Ma enabled auto-merge (squash) August 4, 2021 09:06
@Nic-Ma Nic-Ma merged commit f6ad4ba into Project-MONAI:dev Aug 4, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@wyli wyli wyli approved these changes

@yiheng-wang-nv yiheng-wang-nv yiheng-wang-nv approved these changes

@rijobro rijobro Awaiting requested review from rijobro

@ericspod ericspod Awaiting requested review from ericspod ericspod is a code owner

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

Successfully merging this pull request may close these issues.

Add parameter explanations for Affine, AffineGrid and others The class of AffineGrid has wrong docstring
3 participants
@Nic-Ma @wyli @yiheng-wang-nv