Skip to content

Commit

Permalink
remove backticks around arg types
Browse files Browse the repository at this point in the history
  • Loading branch information
kelsey-wong committed Feb 18, 2025
1 parent 3d30cf2 commit f634d1a
Show file tree
Hide file tree
Showing 2 changed files with 15 additions and 15 deletions.
2 changes: 1 addition & 1 deletion src/cleanlab_codex/__about__.py
Original file line number Diff line number Diff line change
@@ -1,2 +1,2 @@
# SPDX-License-Identifier: MIT
__version__ = "0.0.1a6"
__version__ = "0.0.1a7"
28 changes: 14 additions & 14 deletions src/cleanlab_codex/project.py
Original file line number Diff line number Diff line change
Expand Up @@ -52,9 +52,9 @@ def __init__(self, sdk_client: _Codex, project_id: str, *, verify_existence: boo
[`Client.create_project()`](/reference/python/client#method-create_project), or [`Project.from_access_key()`](/reference/python/project#classmethod-from_access_key) methods.
Args:
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.
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.
"""
self._sdk_client = sdk_client
self._id = project_id
Expand All @@ -73,7 +73,7 @@ def from_access_key(cls, access_key: str) -> Project:
"""Initialize a Project from a [project-level access key](/codex/sme_tutorials/getting_started/#access-keys).
Args:
access_key (`str`): The access key for authenticating project access.
access_key (str): The access key for authenticating project access.
Returns:
Project: The project associated with the access key.
Expand All @@ -92,10 +92,10 @@ def create(cls, sdk_client: _Codex, organization_id: str, name: str, description
"""Create a new Codex project. This method is not meant to be used directly. Instead, use the [`create_project`](/reference/python/client#method-create_project) method on the `Client` class.
Args:
sdk_client (`Codex`): The Codex SDK client to use to create the project. This client must be authenticated with a user-level API key.
organization_id (`str`): The ID of the organization to create the project in.
name (`str`): The name of the project.
description (`str`, optional): The description of the project.
sdk_client (Codex): The Codex SDK client to use to create the project. This client must be authenticated with a user-level API key.
organization_id (str): The ID of the organization to create the project in.
name (str): The name of the project.
description (str, optional): The description of the project.
Returns:
Project: The created project.
Expand All @@ -117,9 +117,9 @@ def create_access_key(self, name: str, description: str | None = None, expiratio
See [`Client.create_project()`](/reference/python/client#method-create_project) or [`Client.get_project()`](/reference/python/client#method-get_project).
Args:
name (`str`): The name of the access key.
description (`str`, optional): The description of the access key.
expiration (`datetime`, optional): The expiration date of the access key. If not provided, the access key will not expire.
name (str): The name of the access key.
description (str, optional): The description of the access key.
expiration (datetime, optional): The expiration date of the access key. If not provided, the access key will not expire.
Returns:
str: The access key token.
Expand Down Expand Up @@ -163,9 +163,9 @@ def query(
"""Query Codex to check if this project contains an answer to the question. Add the question to the project for SME review if it does not.
Args:
question (`str`): The question to ask the Codex API.
fallback_answer (`str`, optional): Optional fallback answer to return if Codex is unable to answer the question.
read_only (`bool`, optional): Whether to query the Codex API in read-only mode. If True, the question will not be added to the Codex project for SME review.
question (str): The question to ask the Codex API.
fallback_answer (str, optional): Optional fallback answer to return if Codex is unable to answer the question.
read_only (bool, optional): Whether to query the Codex API in read-only mode. If True, the question will not be added to the Codex project for SME review.
This can be useful for testing purposes when setting up your project configuration.
Returns:
Expand Down

0 comments on commit f634d1a

Please sign in to comment.