docs: correct grammar and improve clarity on preventing-abuse.mdx #10937
Conversation
This file contains 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
What?
Refactored the explanation of complexity limits in the preventing-abuse.mdx documentation to correct grammar and improve clarity.
Why?
• Grammar fix: The original sentence omitted the preposition "to" ("way specify" → "way to specify").
• Readability: The long, compound sentence was difficult to parse at a glance.
• Concept separation: Merging two ideas (defining limits and explaining scoring) confused the workflow.
How?
• Added the missing "to" to ensure grammatical correctness.
• Split the sentence into two parts:
1. Introduces the purpose of complexity limits.
2. Explains how complexity scores enforce these limits.
• Preserved technical accuracy while simplifying the flow.
AlessioGr
approved these changes
Feb 3, 2025
|
🚀 This is included in version v3.21.0 |
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.
What
Refactored the explanation of complexity limits in the preventing-abuse.mdx documentation to correct grammar and improve clarity.
Why
How