]> git.ipfire.org Git - thirdparty/Chart.js.git/commitdiff
show the utils file in the samples page to clarify what the functions do (#9160)
authorJacco van den Berg <39033624+LeeLenaleee@users.noreply.github.com>
Wed, 26 May 2021 11:55:26 +0000 (13:55 +0200)
committerGitHub <noreply@github.com>
Wed, 26 May 2021 11:55:26 +0000 (07:55 -0400)
docs/.vuepress/config.js
docs/samples/utils.md [new file with mode: 0644]

index 80cc8ff314bae683c7a496a280ebfa364cacf74e..ee97448b5350988bc464d4dc4e2c9d4624fd5173 100644 (file)
@@ -264,6 +264,7 @@ module.exports = {
             'plugins/quadrants',
           ]
         },
+        'utils'
       ],
       '/': [
         '',
diff --git a/docs/samples/utils.md b/docs/samples/utils.md
new file mode 100644 (file)
index 0000000..a1e8faf
--- /dev/null
@@ -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)
+