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.

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

document differences between transforms EnsureType and CastToType #7101

Closed
wyli opened this issue Oct 7, 2023 · 1 comment · Fixed by #7245
Closed

document differences between transforms EnsureType and CastToType #7101

wyli opened this issue Oct 7, 2023 · 1 comment · Fixed by #7245
Assignees
Labels
Contribution wanted documentation Improvements or additions to documentation

Comments

@wyli
Copy link
Contributor

wyli commented Oct 7, 2023

this is a feature request for docstring enhancements to describe the use cases respectively.

@wyli wyli added documentation Improvements or additions to documentation Contribution wanted labels Oct 7, 2023
@ishandutta0098
Copy link
Contributor

Hi @wyli I would like to work on this issue, can you assign it to me?

KumoLiu pushed a commit that referenced this issue Nov 19, 2023
Fixes #7101

### Description

Added examples in the docstrings for `EnsureType` and `CastToType`
transforms which show how they function under different circumstances.

### Types of changes
<!--- Put an `x` in all the boxes that apply, and remove the not
applicable items -->
- [x] 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.
- [x] Integration tests passed locally by running `./runtests.sh -f -u
--net --coverage`.
- [x] Quick tests passed locally by running `./runtests.sh --quick
--unittests --disttests`.
- [ ] In-line docstrings updated.
- [ ] Documentation updated, tested `make html` command in the `docs/`
folder.

Signed-off-by: Ishan Dutta <[email protected]>
marksgraham pushed a commit to marksgraham/MONAI that referenced this issue Jan 30, 2024
)

Fixes Project-MONAI#7101

### Description

Added examples in the docstrings for `EnsureType` and `CastToType`
transforms which show how they function under different circumstances.

### Types of changes
<!--- Put an `x` in all the boxes that apply, and remove the not
applicable items -->
- [x] 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.
- [x] Integration tests passed locally by running `./runtests.sh -f -u
--net --coverage`.
- [x] Quick tests passed locally by running `./runtests.sh --quick
--unittests --disttests`.
- [ ] In-line docstrings updated.
- [ ] Documentation updated, tested `make html` command in the `docs/`
folder.

Signed-off-by: Ishan Dutta <[email protected]>
Signed-off-by: Mark Graham <[email protected]>
juampatronics pushed a commit to juampatronics/MONAI that referenced this issue Mar 25, 2024
)

Fixes Project-MONAI#7101

### Description

Added examples in the docstrings for `EnsureType` and `CastToType`
transforms which show how they function under different circumstances.

### Types of changes
<!--- Put an `x` in all the boxes that apply, and remove the not
applicable items -->
- [x] 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.
- [x] Integration tests passed locally by running `./runtests.sh -f -u
--net --coverage`.
- [x] Quick tests passed locally by running `./runtests.sh --quick
--unittests --disttests`.
- [ ] In-line docstrings updated.
- [ ] Documentation updated, tested `make html` command in the `docs/`
folder.

Signed-off-by: Ishan Dutta <[email protected]>
Signed-off-by: Juan Pablo de la Cruz Gutiérrez <[email protected]>
Yu0610 pushed a commit to Yu0610/MONAI that referenced this issue Apr 11, 2024
)

Fixes Project-MONAI#7101

### Description

Added examples in the docstrings for `EnsureType` and `CastToType`
transforms which show how they function under different circumstances.

### Types of changes
<!--- Put an `x` in all the boxes that apply, and remove the not
applicable items -->
- [x] 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.
- [x] Integration tests passed locally by running `./runtests.sh -f -u
--net --coverage`.
- [x] Quick tests passed locally by running `./runtests.sh --quick
--unittests --disttests`.
- [ ] In-line docstrings updated.
- [ ] Documentation updated, tested `make html` command in the `docs/`
folder.

Signed-off-by: Ishan Dutta <[email protected]>
Signed-off-by: Yu0610 <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Contribution wanted documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants