From da90418bac0f372be622f1a2142d13a76af3f66f Mon Sep 17 00:00:00 2001 From: Dave Landry Date: Thu, 18 Jan 2024 11:11:21 -0500 Subject: [PATCH] updates documentation --- README.md | 13 +++++++------ 1 file changed, 7 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index c994321..f1f2bc2 100644 --- a/README.md +++ b/README.md @@ -77,17 +77,18 @@ This is a global function. --- -#### d3plus.**formatDate**(d, dataArray) [<>](https://github.com/d3plus/d3plus-format/blob/master/src/formatDate.js#L16) +#### d3plus.**formatDate**(d, dataArray, [formatter]) [<>](https://github.com/d3plus/d3plus-format/blob/master/src/formatDate.js#L4) A default set of date formatters, which takes into account both the interval in between in each data point but also the start/end data points. This is a global function. -| Param | Type | Description | -| --- | --- | --- | -| d | Date | The date string to be formatted. | -| dataArray | Array | The full array of ordered Date Objects. | +| Param | Type | Default | Description | +| --- | --- | --- | --- | +| d | Date | | The date string to be formatted. | +| dataArray | Array | | The full array of ordered Date Objects. | +| [formatter] | function | d3.timeFormat | An optional instance of d3.timeFormat to be used for localization. | --- @@ -122,4 +123,4 @@ This is a global namespace. -###### Documentation generated on Wed, 19 Jul 2023 14:05:35 GMT +###### Documentation generated on Thu, 18 Jan 2024 16:11:21 GMT