Skip to content

docs: remove inline code comments from prop type documentation - #2656

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

docs: remove inline code 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:

TEST PLAN:

  • no props table should display inline comments

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

github-actions Bot commented Jul 24, 2026

Copy link
Copy Markdown
Contributor
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-28 12:21 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

github-actions Bot commented Jul 24, 2026

Copy link
Copy Markdown
Contributor

Visual regression report

⚠️ Changes detected.

Status Count
Unchanged 0
Changed 1
New 96
Removed 32

📊 View full report

Diff images (33)

alert.png — baseline no longer produced

avatar.png — baseline no longer produced

badge.png — baseline no longer produced

billboard.png — baseline no longer produced

breadcrumb.png — baseline no longer produced

button-and-derivatives.png — baseline no longer produced

byline.png — baseline no longer produced

calendar.png — baseline no longer produced

checkbox.png — baseline no longer produced

checkboxgroup.png — baseline no longer produced

colorpicker.png — baseline no longer produced

contextview.png — baseline no longer produced

custom-and-lucide-icons.png — baseline no longer produced

dateinput-dateinput2.png — baseline no longer produced

datetimeinput.png — baseline no longer produced

diff-demo.png — 6324 pixels differ

drilldown.png — baseline no longer produced

filedrop.png — baseline no longer produced

form-errors.png — baseline no longer produced

heading.png — baseline no longer produced

img.png — baseline no longer produced

link.png — baseline no longer produced

menu.png — baseline no longer produced

metric-pill-tag-timeselect-text.png — baseline no longer produced

options.png — baseline no longer produced

pagination.png — baseline no longer produced

progressbar.png — baseline no longer produced

select-simpleselect.png — baseline no longer produced

table.png — baseline no longer produced

tabs.png — baseline no longer produced

tooltip.png — baseline no longer produced

treebrowser.png — baseline no longer produced

view.png — baseline no longer produced

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
@ToMESSKa
ToMESSKa force-pushed the INSTUI-5129-prop-documentation-includes-inline-code-comments branch from 7a990bc to c9768b1 Compare July 28, 2026 12:18
@ToMESSKa ToMESSKa changed the title chore: strip inline // comments from prop type documentation docs: remove inline code comments from prop type documentation Jul 28, 2026
calendarIcon: string
prevMonthButton: string
nextMonthButton: string
// TODO: Make this field required in the next version. Currently optional to avoid breaking change.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This was done in v2.

* The "accessible" variant has better color contrast, border and inset focus ring for better accessibility.
*/
thumbVariant?:
| 'deprecated' // TODO: deprecated, remove in V9.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This was done in v2.

@ToMESSKa
ToMESSKa marked this pull request as ready for review July 28, 2026 12:23
github-actions Bot pushed a commit that referenced this pull request Jul 28, 2026
@ToMESSKa
ToMESSKa requested a review from matyasf July 28, 2026 12:42
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