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

storybook: document undocumented Polygon props #3587

Closed
ckifer opened this issue May 15, 2023 · 1 comment
Closed

storybook: document undocumented Polygon props #3587

ckifer opened this issue May 15, 2023 · 1 comment
Assignees
Labels
good first issue Issues with this label are great for first time contributors storybook Issues that require updating or creating stories in the storybook

Comments

@ckifer
Copy link
Member

ckifer commented May 15, 2023

Documentation enhancement

Document undocumented properties of Polygon mentioned in this PR #3586

  • There are two undocumented props: connectNulls, baseLinePoints

Requirements

  • Discover what connectNulls does in context of Polygon
  • Discover what baseLinePoints does in context of Polygon
  • Create acceptable descriptions for these props and add them to the Polygon story storybook
@ckifer ckifer added the storybook Issues that require updating or creating stories in the storybook label May 15, 2023
@ckifer ckifer added the good first issue Issues with this label are great for first time contributors label Jun 12, 2023
@julianna-ciq julianna-ciq self-assigned this Jun 18, 2023
ckifer pushed a commit that referenced this issue Jun 19, 2023
## Description

Provide reasonable descriptions and stories for the Polygon props
`connectNulls` and `baseLinePoints`

## Related Issue

#3587
 
## Motivation and Context

Improving completeness of documentation

## How Has This Been Tested?

<!--- Please describe in detail how you tested your changes. -->
<!--- Include details of your testing environment, and the tests you ran
to -->
<!--- see how your change affects other areas of the code, etc. -->

I made stories and made sure they do what I said they do

## Screenshots (if appropriate):

## Types of changes

<!--- What types of changes does your code introduce? Put an `x` in all
the boxes that apply: -->

- [ ] Bug fix (non-breaking change which fixes an issue)
- [] New feature (non-breaking change which adds functionality)
- [ ] Breaking change (fix or feature that would cause existing
functionality to change)
- [x] Documentation enhancement

## Checklist:

<!--- Go over all the following points, and put an `x` in all the boxes
that apply. -->
<!--- If you're unsure about any of these, don't hesitate to ask. We're
here to help! -->

- [x] My code follows the code style of this project.
- [x] My change requires a change to the documentation.
- [x] I have updated the documentation accordingly.
- [NA] I have added tests to cover my changes.
- [x] All new and existing tests passed.

Co-authored-by: Julianna Langston <julianna@cosaic.io>
@ckifer
Copy link
Member Author

ckifer commented Jun 19, 2023

Closed by #3631

@ckifer ckifer closed this as completed Jun 19, 2023
GMer78 pushed a commit to GMer78/recharts-1 that referenced this issue Nov 24, 2023
)

## Description

Provide reasonable descriptions and stories for the Polygon props
`connectNulls` and `baseLinePoints`

## Related Issue

recharts#3587
 
## Motivation and Context

Improving completeness of documentation

## How Has This Been Tested?

<!--- Please describe in detail how you tested your changes. -->
<!--- Include details of your testing environment, and the tests you ran
to -->
<!--- see how your change affects other areas of the code, etc. -->

I made stories and made sure they do what I said they do

## Screenshots (if appropriate):

## Types of changes

<!--- What types of changes does your code introduce? Put an `x` in all
the boxes that apply: -->

- [ ] Bug fix (non-breaking change which fixes an issue)
- [] New feature (non-breaking change which adds functionality)
- [ ] Breaking change (fix or feature that would cause existing
functionality to change)
- [x] Documentation enhancement

## Checklist:

<!--- Go over all the following points, and put an `x` in all the boxes
that apply. -->
<!--- If you're unsure about any of these, don't hesitate to ask. We're
here to help! -->

- [x] My code follows the code style of this project.
- [x] My change requires a change to the documentation.
- [x] I have updated the documentation accordingly.
- [NA] I have added tests to cover my changes.
- [x] All new and existing tests passed.

Co-authored-by: Julianna Langston <julianna@cosaic.io>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
good first issue Issues with this label are great for first time contributors storybook Issues that require updating or creating stories in the storybook
Projects
None yet
Development

No branches or pull requests

2 participants