Skip to content

Update docstring #293

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.

Sign up for GitHub

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

Closed
brandon-wada wants to merge 1 commit into from
Closed

Update docstring #293

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion src/groundlight/client.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -743,7 +743,7 @@ def ask_confident( # noqa: PLR0913 # pylint: disable=too-many-arguments
converted to JPEG at high quality before sending to service.
:param confidence_threshold: The confidence threshold to wait for.
If not set, use the detector's confidence threshold.
:param wait: How long to wait (in seconds) for a confident answer.
:param wait: How long to wait (in seconds) for a confident answer. Default is 30.0.
Copy link
Collaborator

@roxanne-o roxanne-o Dec 10, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is confusing because the actual default value is None. So maybe you should say explicitly that if it's None, we default to 30. A better solution would be the default value being 30.

:param metadata: A dictionary or JSON string of custom key/value metadata to associate with
the image query (limited to 1KB). You can retrieve this metadata later by calling
`get_image_query()`.
Expand Down
Loading