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

[DOC] audit See Also sections of docs and update deprecation warning strings #325

Closed
grlee77 opened this issue Jun 30, 2022 · 0 comments · Fixed by #356
Closed

[DOC] audit See Also sections of docs and update deprecation warning strings #325

grlee77 opened this issue Jun 30, 2022 · 0 comments · Fixed by #356
Labels
doc Improvements or additions to documentation
Milestone

Comments

@grlee77
Copy link
Contributor

grlee77 commented Jun 30, 2022

Report incorrect documentation

Location of incorrect documentation

See the "See Also" section for random_walker. It mentions skimage.morphology.watershed but we do not currently have watershed in cuCIM. Similar cases can be found elsewhere as well.

Describe the problems or issues found in the documentation

Some current cucim.skimage See Also sections (as copied from scikit-image docstrings) can be misleading when the referred function is not implemented in cuCIM.

Similarly, docstrings notes regarding deprecations are sometime present and mention scikit-image version numbers (e.g. 0.19) while cuCIM uses a different version numbering scheme.

Suggested fix for documentation

We should audit all docstrings and remove references to unimplemented functions (or at least mark them as not implemented)

For deprecations, we should update the message to indicate that the argument is deprecated upstream in scikit-image and will eventually be removed here as well once the upstream deprecation is complete.

@grlee77 grlee77 added the doc Improvements or additions to documentation label Jun 30, 2022
@grlee77 grlee77 added this to the v22.08.00 milestone Jun 30, 2022
@rapids-bot rapids-bot bot closed this as completed in #356 Jul 28, 2022
rapids-bot bot pushed a commit that referenced this issue Jul 28, 2022
…in deprecation warnings (#356)

closes #325

TODO:
- [x] update DeprecationWarning strings

Authors:
  - Gregory Lee (https://github.com/grlee77)

Approvers:
  - https://github.com/jakirkham

URL: #356
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
doc Improvements or additions to documentation
Projects
None yet
1 participant