From: carsonalh <47074583+carsonalh@users.noreply.github.com>
Date: Mon, 29 Nov 2021 21:37:34 +0000 (+1000)
Subject: Update stale documentation for axis titles (#9683)
X-Git-Tag: v3.6.1~4
X-Git-Url: http://git.ipfire.org/?a=commitdiff_plain;h=5e5339d01ce0c5b6a28e96624e0d81b71d459d72;p=thirdparty%2FChart.js.git

Update stale documentation for axis titles (#9683)

* Update stale documentation for axis titles (#9682)

Updated the documentation for the types on axis labels.

In the corresponding `index.esm.d.ts` file, put JSDoc descriptions for
the properties to match the now-updated documentation.

* Clean up axis title labels documentation (#9682)

Inserted extra information in the documentation for the type of the
padding, inserted missing full stops.

In the type file, added JSDoc for undocumented properties.

* Update docs/axes/labelling.md

* Update types/index.esm.d.ts

Co-authored-by: Jukka Kurkela <jukka.kurkela@gmail.com>
---

diff --git a/docs/axes/labelling.md b/docs/axes/labelling.md
index 4f0496e3b..83c365807 100644
--- a/docs/axes/labelling.md
+++ b/docs/axes/labelling.md
@@ -13,7 +13,7 @@ Namespace: `options.scales[scaleId].title`, it defines options for the scale tit
 | `text` | `string`\|`string[]` | `''` | The text for the title. (i.e. "# of People" or "Response Choices").
 | `color` | [`Color`](../general/colors.md) | `Chart.defaults.color` | Color of label.
 | `font` | `Font` | `Chart.defaults.font` | See [Fonts](../general/fonts.md)
-| `padding` | [`Padding`](../general/padding.md) | `4` | Padding to apply around scale labels. Only `top` and `bottom` are implemented.
+| `padding` | [`Padding`](../general/padding.md) | `4` | Padding to apply around scale labels. Only `top`, `bottom` and `y` are implemented.
 
 ## Creating Custom Tick Formats
 
diff --git a/types/index.esm.d.ts b/types/index.esm.d.ts
index cf1570a31..67c251c6d 100644
--- a/types/index.esm.d.ts
+++ b/types/index.esm.d.ts
@@ -2937,15 +2937,26 @@ export interface CartesianScaleOptions extends CoreScaleOptions {
 
   grid: GridLineOptions;
 
+  /** Options for the scale title. */
   title: {
+    /** If true, displays the axis title. */
     display: boolean;
+    /** Alignment of the axis title. */
     align: 'start' | 'center' | 'end';
+    /** The text for the title, e.g. "# of People" or "Response Choices". */
     text: string | string[];
+    /** Color of the axis label. */
     color: Color;
+    /** Information about the axis title font. */
     font: FontSpec;
+    /** Padding to apply around scale labels. */
     padding: number | {
+      /** Padding on the (relative) top side of this axis label. */
       top: number;
+      /** Padding on the (relative) bottom side of this axis label. */
       bottom: number;
+      /** This is a shorthand for defining top/bottom to the same values. */
+      y: number;
     };
   };