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.

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

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

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

Conversation

pierrelalanne
Copy link
Collaborator

Avoid mixing credits and quota.
Credits are one prefix call, on the landing page for instance.
A quota is one quota as counted by the API.

@@ -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?

@@ -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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants