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: add JSDoc for attributes [skip ci] #487

Merged
merged 2 commits into from
Jul 20, 2020
Merged

docs: add JSDoc for attributes [skip ci] #487

merged 2 commits into from
Jul 20, 2020

Conversation

web-padawan
Copy link
Member

Connected to vaadin/vaadin-core#257

@web-padawan web-padawan mentioned this pull request Jul 17, 2020
Closed
20 tasks
alvarezguille
alvarezguille requested changes Jul 20, 2020
View reviewed changes
Copy link
Member

@alvarezguille alvarezguille left a comment

Choose a reason for hiding this comment

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

@attr missing for

  • valueMin in series
  • valueMax in series
  • additionalOptions in series and chart

@web-padawan
Copy link
Member Author

valueMin in series
valueMax in series

Added.

additionalOptions in series and chart

I think we shouldn't encourage using attributes for passing complex data (unless we have to, e.g. in demos).
So in this case I would rather recommend binding to a property instead.

alvarezguille
alvarezguille approved these changes Jul 20, 2020
View reviewed changes
Copy link
Member

@alvarezguille alvarezguille left a comment

Choose a reason for hiding this comment

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

Can you create a new ticket about binding additional options in demos? I think it's quite commonly used there.

@web-padawan
Copy link
Member Author

Created an issue for demos https://github.com/vaadin/vaadin-charts/issues/488

@web-padawan web-padawan merged commit ac856c8 into master Jul 20, 2020
@web-padawan web-padawan deleted the attr-jsdoc branch July 20, 2020 11:51
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@alvarezguille alvarezguille alvarezguille approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@web-padawan @alvarezguille