[Components]: Description improvements for version 2025-07#3877
Merged
[Components]: Description improvements for version 2025-07#3877
Conversation
mcvinci
added
documentation
mcvinci
force-pushed
the
admin-ui-component-descriptions-2025-07
branch
3 times, most recently
from
0249584 to
497ba00
Compare
Contributor
|
We detected some changes in |
mcvinci
added
the
#gsd:49303
mcvinci
force-pushed
the
admin-ui-component-descriptions-2025-07
branch
2 times, most recently
from
ccf1298 to
b704a5c
Compare
Linting Prop descriptions Linting Prop description improvements
Restore links + catch other code syntax instances Linting
mcvinci
force-pushed
the
admin-ui-component-descriptions-2025-07
branch
from
e22c452 to
94b8a2c
Compare
SteveSill
approved these changes
Feb 18, 2026
Contributor
SteveSill
left a comment
SteveSill
left a comment
There was a problem hiding this comment.
Hey! Looking really good. This one took' a while, and I still don't think I got to everything.
I noticed some trends around 'then' placement, 'may' vs. 'might', and 'only' positioning. I'll add them here:
L2. Missing "then" in conditionals (23 instances)
Per style guide: "Include 'then' in conditional sentences ('If X, then Y')."
Pattern: "If/When X, Y" → "If/When X, then Y"
Files affected:
shared/index.ts(7x): lines 126, 155, 163, 960, 968, 1008, 1017Checkbox.ts(2x): lines 17, 61ColorPicker.ts(4x): lines 17, 18, 27, 28ChoiceList.ts(2x): lines 47, 48Banner.ts: line 22Section.ts: line 12FunctionSettings.ts(2x): lines 17, 19AdminAction.ts: line 12AdminBlock.ts: line 11AdminPrintAction.ts: line 10
L3. "may" → "might" for possibility (11 instances)
Per style guide: Use "might" for possibility, "may" for permission only.
Pattern: "may [verb]" → "might [verb]" when expressing possibility.
Files affected:
Button.doc.ts: line 55Section.doc.ts: line 52Heading.doc.ts: line 53AdminBlock.doc.ts(2x): lines 45, 54Link.doc.ts(2x): lines 51, 53MoneyField.doc.ts(2x): lines 45, 52DateField.doc.ts: line 53shared/index.ts: line 140
L4. "only" mispositioned (8 instances)
Per style guide: "Position 'only' next to the word it modifies."
Pattern: "can only be used in" → "can be used only in"
Files affected:
AdminAction.doc.ts: line 52AdminBlock.doc.ts: line 52AdminPrintAction.doc.ts: line 52Badge.doc.ts: line 53EmailField.doc.ts: line 53Paragraph.doc.ts: line 53ProgressIndicator.doc.ts: line 51shared/index.ts: line 1379
This was referenced Feb 18, 2026
Co-authored-by: Cursor <cursoragent@cursor.com>
SteveSill
approved these changes
Feb 18, 2026
Contributor
SteveSill
left a comment
SteveSill
left a comment
There was a problem hiding this comment.
Stumbled on a few issues with 2024-10 that made me circle back to this one. 😄
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
This PR: