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.

Sign up for GitHub

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

Jump to bottom

docs(d, f, g, and h-named components): update api description refs #8540

Merged
merged 8 commits into from
Jan 3, 2024
Merged

docs(d, f, g, and h-named components): update api description refs #8540

merged 8 commits into from
Jan 3, 2024

Conversation

DitwanP
Copy link
Contributor

@DitwanP DitwanP commented Jan 2, 2024

Related Issue: #7071

Summary

Updates doc consistency across b and c-named components defined in the above issue for props, events, methods, and css vars, including:

  • date-picker-day
  • date-picker-month
  • date-picker-month-header
  • dropdown-group
  • dropdown-item
  • filter
  • graph
  • handle

cc @geospatialem

@DitwanP DitwanP requested a review from a team as a code owner January 2, 2024 23:11
@github-actions github-actions bot added the docs Issues relating to documentation updates only. label Jan 2, 2024
@DitwanP DitwanP added the skip visual snapshots Pull requests that do not need visual regression testing. label Jan 2, 2024
@DitwanP
Merge branch 'main' of https://github.com/Esri/calcite-design-system …
3e0fb81 
…into dit13711/7071-update-api-description-refs-for-d-and-f-named-components
geospatialem
geospatialem approved these changes Jan 3, 2024
View reviewed changes
Copy link
Member

@geospatialem geospatialem left a comment •
edited
Loading

Choose a reason for hiding this comment

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

Awesome! Reviewed the doc'd components, dropdown-group, dropdown-item, and filter. 🏆

It looks like there were some changes to the optional props in calcite-date-picker-month, which could have ramifications elsewhere. Since its a JSDoc change and we aren't officially documenting the component, wondering if we could add the ? back in for good measure?

Otherwise, the non-doc'd component doc changes can be merged in as part of the PR, but out of scope for the review. 🔍

packages/calcite-components/src/components/dropdown-group/dropdown-group.tsx Outdated Show resolved Hide resolved
packages/calcite-components/src/components/date-picker-month/date-picker-month.tsx Outdated Show resolved Hide resolved
@DitwanP
Copy link
Contributor Author

DitwanP commented Jan 3, 2024

Awesome! Reviewed the doc'd components, dropdown-group, dropdown-item, and filter. 🏆

It looks like there were some changes to the optional props in calcite-date-picker-month, which could have ramifications elsewhere. Since its a JSDoc change and we aren't officially documenting the component, wondering if we could add the ? back in for good measure?

Otherwise, the non-doc'd component doc changes can be merged in as part of the PR, but out of scope for the review. 🔍

For the optional tag, theres a bullet in the list of things to check that says to remove them or is that referring to something else?

@DitwanP DitwanP requested a review from geospatialem January 3, 2024 17:29
@geospatialem
Copy link
Member

For the optional tag, theres a bullet in the list of things to check that says to remove them or is that referring to something else?

Yes, that's accurate, but for the documented components. Its likely outdated now with our move to 1.0.0 last January, since that's not something we've documented since the first production release.

With the undocumented components there is the possibility of tests that could fail as a result of removing the optional JSDoc tag.

@DitwanP
Copy link
Contributor Author

DitwanP commented Jan 3, 2024

With the undocumented components there is the possibility of tests that could fail as a result of removing the optional JSDoc tag.

Ahh okay, got it! 👍

geospatialem
geospatialem approved these changes Jan 3, 2024
View reviewed changes
Copy link
Member

@geospatialem geospatialem left a comment

Choose a reason for hiding this comment

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

Great additions! 🎇

@DitwanP DitwanP merged commit 2e62c49 into main Jan 3, 2024
11 checks passed
@DitwanP DitwanP deleted the dit13711/7071-update-api-description-refs branch January 3, 2024 20:28
@github-actions github-actions bot added this to the 2024-01-17 - Jan Main Release milestone Jan 3, 2024
benelan added a commit that referenced this pull request Jan 4, 2024
@benelan
Merge remote-tracking branch 'origin/main' into benelan/required-prop…
08fb2b7 
…-not-internal

* origin/main:
  docs(d, f, g, and h-named components): update api description refs (#8540)
  docs(b and c components): consistent api description refs (#8536)
  ci(update-doc): build design tokens to prevent errors (#8542)
  docs: update component readmes (#8543)
  ci: consistent formatting across packages (#8534)
  refactor(list-item): Remove unnecessary code for rendering open caret (#8537)
  docs(tab-nav, table, tabs, tile-select, tree, value-list): consistent api description refs (#8535)
  chore: release next
  feat(list-item): Add dragSelected property and calciteListItemDragHandleChange event (#8524)
  chore: release next
  fix(input-date-picker): hard to reproduce numbering-system caching issue (#8518)
  feat(handle): add selected property and calciteHandleChange event. (#8484)
  docs(action-bar, action-group, action-pad, alert): consistent api decription refs (#8533)
benelan added a commit that referenced this pull request Jan 4, 2024
@benelan
Merge remote-tracking branch 'origin/main' into benelan/8000-form-val…
4eee8bf 
…idation-ui

* origin/main:
  docs(d, f, g, and h-named components): update api description refs (#8540)
  docs(b and c components): consistent api description refs (#8536)
benelan added a commit that referenced this pull request Jan 5, 2024
@benelan
Merge remote-tracking branch 'origin/main' into benelan/7866-input-nu…
67cd152 
…mber-infinity

* origin/main:
  refactor: remove @ts-ignore needed for Stencil missing  in JSX types (#8551)
  refactor(combobox): remove unused interface (#8552)
  fix(input-date-picker): ensure range icon toggles open corresponding date-picker (#8554)
  fix(button): avoid needlessly overwriting title (#8491)
  docs(d, f, g, and h-named components): update api description refs (#8540)
  docs(b and c components): consistent api description refs (#8536)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@geospatialem geospatialem geospatialem approved these changes

Assignees

@DitwanP DitwanP

Labels
docs Issues relating to documentation updates only. skip visual snapshots Pull requests that do not need visual regression testing.
Projects
None yet
Milestone
2024-01-17 - Jan Main Release
Development

Successfully merging this pull request may close these issues.
2 participants
@DitwanP @geospatialem