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

use the sphinx directives for deprecated warning #2639

Closed
wyli opened this issue Jul 21, 2021 · 0 comments · Fixed by #2865
Closed

use the sphinx directives for deprecated warning #2639

wyli opened this issue Jul 21, 2021 · 0 comments · Fixed by #2865
Labels
enhancement New feature or request

Comments

@wyli
Copy link
Contributor

wyli commented Jul 21, 2021

Is your feature request related to a problem? Please describe.
part of the feature request #233,
the relevant docstrings should include details for

  • versionadded
  • versionchanged
  • deprecated

according to
https://www.sphinx-doc.org/en/master/usage/restructuredtext/directives.html#directive-versionadded

the contributing guide should be updated to recommend the usage.
@Nic-Ma Nic-Ma added the enhancement New feature or request label Jul 21, 2021
wyli added a commit to wyli/MONAI that referenced this issue Aug 30, 2021
@wyli
fixes Project-MONAI#2639
62c8c0a 
Signed-off-by: Wenqi Li <wenqil@nvidia.com>
wyli added a commit to wyli/MONAI that referenced this issue Aug 30, 2021
@wyli
fixes Project-MONAI#2639
27d810e 
Signed-off-by: Wenqi Li <wenqil@nvidia.com>
wyli added a commit to wyli/MONAI that referenced this issue Aug 30, 2021
@wyli
fixes Project-MONAI#2639
9a83de8 
Signed-off-by: Wenqi Li <wenqil@nvidia.com>
@wyli wyli mentioned this issue Aug 30, 2021
Merged
3 tasks
wyli added a commit that referenced this issue Aug 31, 2021
@wyli
2639 documentation for the deprecated API (#2865)
e9f6e51 
* fixes #2639

Signed-off-by: Wenqi Li <wenqil@nvidia.com>

* fixes typo

Signed-off-by: Wenqi Li <wenqil@nvidia.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
enhancement New feature or request
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

2639 documentation for the deprecated API wyli/MONAI
2 participants
@wyli @Nic-Ma