Skip to content
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

Jump to bottom

chore(wording): # Reword credits to quotas for clarity #781

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

chore(wording): # Reword credits to quotas for clarity #781

Show file tree
Hide file tree
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.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
2 changes: 1 addition & 1 deletion ggshield/cmd/hmsl/quota.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ def quota_cmd(
**kwargs: Any,
) -> int:
"""
Get the number of remaining credits for today.
Get the remaining quotas for today.
Copy link
Collaborator

Choose a reason for hiding this comment

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

I don't know if "credits" was the correct word, but I believe "quotas" is not the correct one here. A quota is a limit on something. The only reason it would be plural if is you have several different limits (a soft-limit and a hard-limit for example).

Maybe "API calls" is what we want here, just like in ggshield quota?

Copy link
Collaborator

Choose a reason for hiding this comment

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

It may be more complex but what do you guys think of "consumption units" ?

Copy link
Collaborator

Choose a reason for hiding this comment

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

Sounds a bit complex indeed. I thought it would make sense to sync this with the dashboard, but I can't see any mention to this there. Maybe I haven't been looking in the right place?

"""

# Get our client
Expand Down
2 changes: 1 addition & 1 deletion ggshield/cmd/quota.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@
@click.pass_context
def quota_cmd(ctx: click.Context, **kwargs: Any) -> int:
"""
Show the remaining quota of API calls available for the entire workspace.
Show the remaining quotas of API calls available for the entire workspace.
Copy link
Collaborator

Choose a reason for hiding this comment

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

Suggested change
Show the remaining quotas of API calls available for the entire workspace.
Show the remaining number of API calls available for the entire workspace.

"""
client: GGClient = create_client_from_config(ctx.obj["config"])
response: Union[Detail, QuotaResponse] = client.quota_overview()
Expand Down
2 changes: 1 addition & 1 deletion ggshield/verticals/hmsl/client.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -87,7 +87,7 @@ def __init__(

@property
def quota(self) -> Quota:
"""Return the remaining credits."""
"""Return the remaining quotas for the day."""
if self._quota is None:
# Use the side effect of the call to set the remaining credits
self.check_prefixes([])
Expand Down
4 changes: 2 additions & 2 deletions ggshield/verticals/hmsl/output.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -95,10 +95,10 @@ def show_results(

def show_error_during_scan(error: Exception):
if isinstance(error, HTTPError) and error.response.status_code == 429:
error_message = "These are partial results: Quota exceeded"
error_message = "These are partial results: quota exceeded"
if error.response.headers.get("RateLimit-Query") is not None:
error_message += (
f" required {error.response.headers.get('RateLimit-Query')} credits."
f" required {error.response.headers.get('RateLimit-Query')} quotas."
)
else:
error_message += "."
Expand Down