docs: fix a few hyperlinks in the Python SDK reference. #8693
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
✅ Deploy Preview for determined-ui canceled.
|
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #8693 +/- ##
==========================================
- Coverage 51.50% 46.32% -5.19%
==========================================
Files 887 726 -161
Lines 156212 144482 -11730
Branches 2088 2088
==========================================
- Hits 80462 66932 -13530
- Misses 74256 76057 +1801
+ Partials 1494 1493 -1
Flags with carried forward coverage won't be shown. Click here to find out more.
|
wes-turner
reviewed
Jan 12, 2024
| When false, filter for inactive users. Return all users otherwise. | ||
|
|
||
| Returns: | ||
| :class:`~determined.common.experimental.user.User`. |
There was a problem hiding this comment.
nit: actually returns a list of them
There was a problem hiding this comment.
Also, could you make please prefer determined.experimental.client.User to determined.common.experimental.user.User path? The former is the public path, even if Sphinx autodoc doesn't always pick the right one in the existing docs.
Tested on my system, link seems fine after changing to client.User.
wes-turner
approved these changes
Jan 13, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
I’ve been asked why did the docstring for the
Experimentclass https://docs.determined.ai/latest/reference/python-sdk.html#determined.experimental.client.Experimenthas
determined.experimental.client.get_experiment()in it, but it’s not a hyperlink.I went in and added
:func:,:attr:, and:meth:annotations for it and a few classes nearby.Also added docs autogen for a bunch of missing methods in
determined.experimental.client, and missingUserandResourcePoolclass references.Test Plan
Are things which look like methods and functions in the docs actually getting rendered as hyperlinks?
Commentary (optional)
If you find more broken or nonexisting links which are not in this PR, please make your own PR to fix them.
Checklist
docs/release-notes/.See Release Note for details.
Ticket