docstrings for SDK reference docs #938
Merged
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
hansent
requested review from
PawelPeczek-Roboflow,
grzegorz-roboflow,
yeldarby and
probicheaux
as code owners
hansent
commented
Jan 13, 2025
| @@ -167,6 +167,7 @@ scratch | |||
| docs/workflows/blocks/* | |||
| docs/workflows/kinds/* | |||
| docs/workflows/gallery/* | |||
| docs/reference/* | |||
There was a problem hiding this comment.
these files get autogenerated via gen_ref_pages.py / gen-files mkdocs plugin
yeldarby
approved these changes
Jan 13, 2025
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
Adds proper docstrings to public classes/functions etc in the inference_sdk module so the reference docs get generated meaningfully
Type of change
Docs update
How has this change been tested, please provide a testcase or example of how you tested the change?
locally with
mkdocs serveAny specific deployment considerations
docs build
Docs
lots of docstrings added. I added most of them vial Claude / cursor by prompting it to add docstrings in google format. Looked pretty good at generating one sentence descriptions and parameter / return lists