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

chore: Add docs to the Select component props #17171

Merged
merged 6 commits into from
Oct 26, 2021
Merged

chore: Add docs to the Select component props #17171

merged 6 commits into from
Oct 26, 2021

Conversation

geido
Copy link
Member

@geido geido commented Oct 20, 2021

SUMMARY

This PR adds documentation for the custom properties of the Select component.

ADDITIONAL INFORMATION

  • Has associated issue:
  • Required feature flags:
  • Changes UI
  • Includes DB Migration (follow approval process in SIP-59)
    • Migration is atomic, supports rollback & is backwards-compatible
    • Confirm DB migration upgrade and downgrade tested
    • Runtime estimates and downtime expectations provided
  • Introduces new feature or API
  • Removes existing feature or API

@codecov
Copy link

codecov bot commented Oct 20, 2021

Codecov Report

Merging #17171 (b81bca1) into master (4c96ae7) will not change coverage.
The diff coverage is n/a.

❗ Current head b81bca1 differs from pull request most recent head 61a58c4. Consider uploading reports for the commit 61a58c4 to get more accurate results
Impacted file tree graph

@@           Coverage Diff           @@
##           master   #17171   +/-   ##
=======================================
  Coverage   76.95%   76.95%           
=======================================
  Files        1038     1038           
  Lines       55597    55597           
  Branches     7585     7585           
=======================================
  Hits        42787    42787           
  Misses      12560    12560           
  Partials      250      250           
Flag Coverage Δ
javascript 71.00% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

Impacted Files Coverage Δ
superset-frontend/src/components/Select/Select.tsx 92.35% <ø> (ø)
...nd/src/explore/components/ExploreActionButtons.tsx 71.73% <ø> (ø)

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 4c96ae7...61a58c4. Read the comment docs.

@@ -82,17 +82,80 @@ export type OptionsPagePromise = (
) => Promise<OptionsTypePage>;

export interface SelectProps extends PickedSelectProps {
Copy link
Member

Choose a reason for hiding this comment

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

Can we add a description to the component as well? Some things that can be in the description:

  • The different modes of operation (static and async)
  • The differences and motivation that lead us to increment the default Ant Design Select.
  • The reasoning/criteria for not exposing some props but instead using default values (simplification, standard behavior)
  • A reference to the Storybook file
  • A reference to the Ant Design API for the other properties

Copy link
Member Author

Choose a reason for hiding this comment

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

Hey @michael-s-molina. I added the description. Please have a look

@michael-s-molina
Copy link
Member

michael-s-molina commented Oct 22, 2021

This is looking great! The bar for this component is definitely high with the docs, storybook and tests 🚀

Copy link
Member

@michael-s-molina michael-s-molina left a comment

Choose a reason for hiding this comment

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

Great! Thanks for the awesome work!

@geido geido merged commit 48fd3c1 into apache:master Oct 26, 2021
@mistercrunch mistercrunch added 🏷️ bot A label used by `supersetbot` to keep track of which PR where auto-tagged with release labels 🚢 1.5.0 labels Mar 13, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
🏷️ bot A label used by `supersetbot` to keep track of which PR where auto-tagged with release labels size/L 🚢 1.5.0
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants