Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: Surfacing Dropdown and Combobox prop comments to docsite #31430

Merged
merged 3 commits into from
May 21, 2024

Conversation

khmakoto
Copy link
Member

Previous Behavior

The documentation comments of some props in Dropdown and Combobox were not being correctly surfaced to the docsite.

New Behavior

This was happening because some of the comments had /* instead of /**, which is what indicates the docsite which comments to surface. This PR fixes this issue so that those comments are correctly surfaced now.

Related Issue(s)

@khmakoto khmakoto self-assigned this May 20, 2024
@khmakoto khmakoto requested review from smhigley and a team as code owners May 20, 2024 23:27
@github-actions github-actions bot added this to the April Project Cycle Q1 2024 milestone May 20, 2024
@khmakoto khmakoto enabled auto-merge (squash) May 20, 2024 23:35
@fabricteam
Copy link
Collaborator

fabricteam commented May 20, 2024

📊 Bundle size report

✅ No changes found

@fabricteam
Copy link
Collaborator

fabricteam commented May 20, 2024

Perf Analysis (@fluentui/react-components)

No significant results to display.

All results

Scenario Render type Master Ticks PR Ticks Iterations Status
Avatar mount 617 624 5000
Button mount 304 311 5000
Field mount 1144 1152 5000
FluentProvider mount 697 709 5000
FluentProviderWithTheme mount 80 86 10
FluentProviderWithTheme virtual-rerender 36 35 10
FluentProviderWithTheme virtual-rerender-with-unmount 88 78 10
MakeStyles mount 870 866 50000
Persona mount 1778 1758 5000
SpinButton mount 1390 1418 5000
SwatchPicker mount 1545 1557 5000

Copy link

This pull request is automatically built and testable in CodeSandbox.

To see build info of the built libraries, click here or the icon next to each commit SHA.

@khmakoto khmakoto merged commit 4381727 into microsoft:master May 21, 2024
18 of 20 checks passed
@fabricteam
Copy link
Collaborator

🕵 fluentuiv9 No visual regressions between this PR and main

@khmakoto khmakoto deleted the v9/Dropdown/exposePropsInDocsite branch May 21, 2024 00:16
marcosmoura added a commit to marcosmoura/fluentui that referenced this pull request May 21, 2024
* master:
  applying package updates
  applying package updates
  docs: Surfacing `Dropdown` and `Combobox` prop comments to docsite (microsoft#31430)
  (web-components) call click in button keydownHandler (microsoft#31428)
  Modify data and color codes for examples to fix accessibility issues (microsoft#31425)
  chore(deps): bump semver from 5.7.1 to 6.3.1 (microsoft#31420)
  applying package updates
  Improve gauge chart screen reader accessibility (microsoft#26682)
  applying package updates
  applying package updates
miroslavstastny pushed a commit to miroslavstastny/fluentui that referenced this pull request Jun 14, 2024
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.

[Bug]: Documentation for Dropdown is missing for some properties
5 participants