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(component): fix missing DropdownComponent displayName property #634

Merged

Conversation

cadomani
Copy link
Contributor

@cadomani cadomani commented Feb 28, 2023

Description

This PR fixes the Dropdown component documentation so that it runs as-is. A missing displayName property caused the documentation to render an invalid name for the component.

Related to #616

Type of change

  • This change contains documentation update

Checklist:

  • My code follows the style guidelines of this project
  • I have performed a self-review of my own code
  • I have commented my code, particularly in hard-to-understand areas
  • I have made corresponding changes to the documentation
  • My changes generate no new warnings
  • I have added tests that prove my fix is effective or that my feature works
  • New and existing unit tests pass locally with my changes
  • Any dependent changes have been merged and published in downstream modules
  • I have checked my code and corrected any misspellings

@codecov
Copy link

codecov bot commented Feb 28, 2023

Codecov Report

Patch coverage: 100.00% and no project coverage change

Comparison is base (eab6bbb) 99.42% compared to head (305dda8) 99.42%.

Additional details and impacted files
@@           Coverage Diff           @@
##             main     #634   +/-   ##
=======================================
  Coverage   99.42%   99.42%           
=======================================
  Files         130      130           
  Lines        6413     6414    +1     
  Branches      477      477           
=======================================
+ Hits         6376     6377    +1     
  Misses         37       37           
Impacted Files Coverage Δ
src/lib/components/Dropdown/Dropdown.tsx 100.00% <100.00%> (ø)

Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here.

☔ View full report at Codecov.
📢 Do you have feedback about the report comment? Let us know in this issue.

@tulup-conner
Copy link
Collaborator

Thanks, this is wonderful. Do you have the time to fix this issue in the other components it is present? I think there's at least one- but I may be wrong. If not, let me know and we can just merge this one

@cadomani
Copy link
Contributor Author

cadomani commented Mar 2, 2023

@tulup-conner I looked through the documentation page and couldn't identify any other components that had a similar issue. Do you remember which other component was causing issues?

@tulup-conner
Copy link
Collaborator

@tulup-conner I looked through the documentation page and couldn't identify any other components that had a similar issue. Do you remember which other component was causing issues?

None in particular, so I'm probably just re-remembering this one. Thank you for looking around all of the components, that helps a lot

@cadomani
Copy link
Contributor Author

cadomani commented Mar 2, 2023

It's a minor change, but I'm happy to help!

@tulup-conner
Copy link
Collaborator

BTW, see #641 - it looks like we have at least one other component in Select. If you have the time it would be great if you could add that to this PR, let me know

@tulup-conner
Copy link
Collaborator

Never mind, another user offered to pick that one up!

@tulup-conner tulup-conner force-pushed the fix-dropdown-documentation-examples branch from eb20e87 to 305dda8 Compare March 5, 2023 17:46
@tulup-conner tulup-conner merged commit 959b88b into themesberg:main Mar 5, 2023
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.

2 participants