Skip to content

docs: improve code examples in charts JSDoc annotations #9964

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
Merged
merged 1 commit into from
Aug 11, 2025
Merged

docs: improve code examples in charts JSDoc annotations #9964

merged 1 commit into from
Aug 11, 2025

Conversation

web-padawan
Copy link
Member

Description

  • Fixed indentation in vaadin-chart and vaadin-chart-series JSDoc to align with other components
  • Removed mentions of this.$.mychart and connectedCallback() as those assume using Polymer
  • Simplified headings so that they would look nicer in the "table of contents" of new static API docs

Type of change

  • Documentation

@sonarqubecloud SonarQubeCloud
Copy link

Quality Gate Passed Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarQube Cloud

@web-padawan web-padawan merged commit d169f3e into main Aug 11, 2025
9 checks passed
@web-padawan web-padawan deleted the docs/chart-api-improve branch August 11, 2025 14:47
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@DiegoCardoso DiegoCardoso DiegoCardoso 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 @DiegoCardoso