update comments and types for generating python API reference #38
Conversation
kelsey-wong
force-pushed
the
fix-docs
branch
from
5f69aae to
0a11860
Compare
|
@axl1313 I want to make some small updates to the docstrings here so that they'll be better on the docs site, but how do I actually flow these changes forward to the docs site? Do I need to tag and publish a new version of the library? |
Yup currently will need to tag and release a new version to trigger the docs rebuild. |
src/cleanlab_codex/project.py
Outdated
| sdk_client (`Codex`): The Codex SDK client to use to interact with the project. | ||
| project_id (`str`): The ID of the project. | ||
| verify_existence (`bool`, optional): Whether to verify that the project exists. |
There was a problem hiding this comment.
nit: for consistency across the docs can we remove the backticks around the types for args? The generated docs apply {arg_name} formatting around the argument name already, so having the arg type formatted as code too looks a little weird
Add/update docstrings so they look better for the Python API Reference section of our docs site