Skip to content

chore: strip inline // comments from prop type documentation#2656

Draft
ToMESSKa wants to merge 1 commit into
masterfrom
INSTUI-5129-prop-documentation-includes-inline-code-comments
Draft

chore: strip inline // comments from prop type documentation#2656
ToMESSKa wants to merge 1 commit into
masterfrom
INSTUI-5129-prop-documentation-includes-inline-code-comments

Conversation

@ToMESSKa

@ToMESSKa ToMESSKa commented Jul 24, 2026

Copy link
Copy Markdown
Contributor

INSTUI-5129

ISSUE:

  • prop documentation table was showing inline source-code comments as if they were part of the type (e.g. the display prop of View) making them hard to read

TEST PLAN:

  • check the prop table of View (e.g. display prop) or Text (e.g color prop) v2 on the docs page, the table should not include // comments but everything else should be the same
  • check packages/__docs__/__build__/markdowns/Text.md after pnpm run dev, the file should not include comments either

@ToMESSKa ToMESSKa self-assigned this Jul 24, 2026
@github-actions

Copy link
Copy Markdown
PR Preview Action v1.8.1

QR code for preview link

🚀 View preview at
https://instructure.design/pr-preview/pr-2656/

Built to branch gh-pages at 2026-07-24 07:33 UTC.
Preview will be ready when the GitHub Pages deployment is complete.

github-actions Bot pushed a commit that referenced this pull request Jul 24, 2026
@github-actions

Copy link
Copy Markdown

Visual regression report

No changes.

Status Count
Unchanged 32
Changed 0
New 0
Removed 0

📊 View full report

Baselines come from the visual-baselines branch. They refresh on every merge to master.

@ToMESSKa
ToMESSKa marked this pull request as draft July 24, 2026 08:03
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant