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

show the utils file in the samples page to clarify what the functions do #9160

Merged
merged 1 commit into from May 26, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
1 change: 1 addition & 0 deletions docs/.vuepress/config.js
Expand Up @@ -264,6 +264,7 @@ module.exports = {
'plugins/quadrants',
]
},
'utils'
],
'/': [
'',
Expand Down
14 changes: 14 additions & 0 deletions docs/samples/utils.md
@@ -0,0 +1,14 @@
# Utils

## Disclaimer
The Utils file contains multiple helper functions that the chart.js sample pages use to generate charts.
These functions are subject to change, including but not limited to breaking changes without prior notice.

Because of this please don't rely on this file in production environments.

## Functions

<<< @/docs/scripts/utils.js

[File on github](https://github.com/chartjs/Chart.js/blob/master/docs/scripts/utils.js)