Format the quota/limit style guide. (#21017)

This commit is contained in:
Sam Roberts
2026-03-03 13:37:05 -08:00
committed by GitHub
parent b5f3eb2c9c
commit fdf5b18cfb

View File

@@ -1,13 +1,19 @@
# Style Guide: Quota vs. Limit # Style Guide: Quota vs. Limit
This guide defines the usage of "quota," "limit," and related terms in user-facing interfaces. This guide defines the usage of "quota," "limit," and related terms in
user-facing interfaces.
## TL;DR ## TL;DR
- **`quota`**: The administrative "bucket." Use for settings, billing, and requesting increases. (e.g., "Adjust your storage **quota**.") - **`quota`**: The administrative "bucket." Use for settings, billing, and
- **`limit`**: The real-time numerical "ceiling." Use for error messages when a user is blocked. (e.g., "You've reached your request **limit**.") requesting increases. (e.g., "Adjust your storage **quota**.")
- **When blocked, combine them:** Explain the **limit** that was hit and the **quota** that is the remedy. (e.g., "You've reached the request **limit** for your developer **quota**.") - **`limit`**: The real-time numerical "ceiling." Use for error messages when a
- **Related terms:** Use `usage` for consumption tracking, `restriction` for fixed rules, and `reset` for when a limit refreshes. user is blocked. (e.g., "You've reached your request **limit**.")
- **When blocked, combine them:** Explain the **limit** that was hit and the
**quota** that is the remedy. (e.g., "You've reached the request **limit** for
your developer **quota**.")
- **Related terms:** Use `usage` for consumption tracking, `restriction` for
fixed rules, and `reset` for when a limit refreshes.
--- ---
@@ -15,31 +21,41 @@ This guide defines the usage of "quota," "limit," and related terms in user-faci
### Definitions ### Definitions
- **Quota is the "what":** It identifies the category of resource being managed (e.g., storage quota, GPU quota, request/prompt quota). - **Quota is the "what":** It identifies the category of resource being managed
(e.g., storage quota, GPU quota, request/prompt quota).
- **Limit is the "how much":** It defines the numerical boundary. - **Limit is the "how much":** It defines the numerical boundary.
Use **quota** when referring to the administrative concept or the request for more. Use **limit** when discussing the specific point of exhaustion. Use **quota** when referring to the administrative concept or the request for
more. Use **limit** when discussing the specific point of exhaustion.
### When to use "quota" ### When to use "quota"
Use this term for **account management, billing, and settings.** It describes the entitlement the user has purchased or been assigned. Use this term for **account management, billing, and settings.** It describes
the entitlement the user has purchased or been assigned.
**Examples:** **Examples:**
- **Navigation label:** Quota and usage - **Navigation label:** Quota and usage
- **Contextual help:** Your **usage quota** is managed by your organization. To request an increase, contact your administrator. - **Contextual help:** Your **usage quota** is managed by your organization. To
request an increase, contact your administrator.
### When to use "limit" ### When to use "limit"
Use this term for **real-time feedback, notifications, and error messages.** It identifies the specific wall the user just hit. Use this term for **real-time feedback, notifications, and error messages.** It
identifies the specific wall the user just hit.
**Examples:** **Examples:**
- **Error message:** Youve reached the 50-request-per-minute **limit**. - **Error message:** Youve reached the 50-request-per-minute **limit**.
- **Inline warning:** Input exceeds the 32k token **limit**. - **Inline warning:** Input exceeds the 32k token **limit**.
### How to use both together ### How to use both together
When a user is blocked, combine both terms to explain the **event** (limit) and the **remedy** (quota). When a user is blocked, combine both terms to explain the **event** (limit) and
the **remedy** (quota).
**Example:** **Example:**
- **Heading:** Daily usage limit reached - **Heading:** Daily usage limit reached
- **Body:** You've reached the maximum daily capacity for your developer quota. To continue working today, upgrade your quota. - **Body:** You've reached the maximum daily capacity for your developer quota.
To continue working today, upgrade your quota.