-
Notifications
You must be signed in to change notification settings - Fork 540
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
[REVIEW] Cleanup sphinx doc warnings for 0.15 #2649
[REVIEW] Cleanup sphinx doc warnings for 0.15 #2649
Conversation
Please update the changelog in order to start CI tests. View the gpuCI docs here. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
lgtm pending CI and changelog conflict fix, found one small character that might not be needed but besides that its great to see this fixes!
python/cuml/dask/manifold/umap.py
Outdated
@@ -95,7 +98,7 @@ def __init__(self, model, client=None, **kwargs): | |||
self._set_internal_model(model) | |||
|
|||
def transform(self, X, convert_dtype=True): | |||
""" | |||
r""" |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
why is this needed?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Good catch. I was seeing some weird errors with hyperlinks and tried to convert to a literal string to avoid any html link issues. It did not work so this can be removed.
The latest commits have cleaned up all possible sphinx warnings and errors. To resolve them, the following changes were made (numbers match the remaining warnings section above):
@dantegd Can you give this a quick look and merge once CI has completed? |
This PR pulls warnings cleanup from
mdemoret-nv:fea-improve-doc-examples-source
which was completed as part of the documentation source improvement. Since that PR is blocked until 0.16, the warning cleanup was cherry picked into a separate PR.While there are still outstanding warnings, this does clean up the majority of the basic warnings and improves the documentation. This includes the following types of fixes:
.. note::
sections to replace "Note: "\
where needed for parameter typesRemaining warnings that were not cleaned up:
WARNING: Unexpected indentation.
messages. The cause is unclear for these warnings.WARNING: duplicate object description...
seem to be caused by very similar documentation for different objects. Need author input on whether the docs can be tweaked to show the difference between the objects.WARNING: Unknown target name
. The following link suggests this may be due to hyperlinks, however removing all links did not cause the messages to disappear. Need further research.@dantegd This should hopefully work well with #2635. I would appreciate any feedback you have on these changes