fix: more description for tag modifing behavior for clients #3259
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Contributor
There was a problem hiding this comment.
Pull request overview
This PR enhances the documentation for the Client Tag module by adding more detailed descriptions about tag modification behavior. The changes clarify how QoS level restrictions work and explain what happens when tags are edited or deleted.
Key Changes
- Clarified that QoS level
0is a restriction (not "no restriction"), unlike other limit values where0means no limit - Added explicit documentation that editing a tag immediately updates rate limiting for all associated clients at the next check
- Documented that deleting a tag reassigns clients to the
defaulttag with immediate application of its rate limiting policy
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 2 comments.
| File | Description |
|---|---|
| zh_CN/modules/client_tag.md | Chinese version: Enhanced tip section explaining QoS level behavior and added details about tag management consequences |
| en_US/modules/client_tag.md | English version: Enhanced tip section explaining QoS level behavior and added details about tag management consequences |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
en_US/modules/client_tag.md
Outdated
| - **Create**: Click **Add** to add new tags and configure rate-limiting policies. For detailed configuration descriptions, see [Configurable Limits](#configurable-limits). | ||
| - **Manage**: Edit rate-limiting strategies or view the client list under a tag by clicking the **View Client List** button. | ||
| - **Delete**: Delete a tag that is no longer needed. | ||
| - **Manage**: Edit the rate-limiting policie of an existing tag, or click **View Client List** to check all clients associated with that tag . |
There was a problem hiding this comment.
Spacing issue: There's an extra space before the period. It should be "that tag." instead of "that tag ."
Suggested change
| - **Manage**: Edit the rate-limiting policie of an existing tag, or click **View Client List** to check all clients associated with that tag . | |
| - **Manage**: Edit the rate-limiting policie of an existing tag, or click **View Client List** to check all clients associated with that tag. |
Co-authored-by: Copilot <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
No description provided.