Fix the documentation for the `dateFormats` and `timeFormats` configuration options #956

sequba · 2022-04-05T14:04:37Z

Context

make API reference for dateFormats more accurate (mention . as a valid separator)
make API reference for timeFormats more accurate
fix date-and-time-handling.md
cross-link between date-and-time-handling.md and API reference
change the implementation of the default time-parsing function to return the same value for timeFormats: ['hh:mm:ss'] and timeFormats: ['hh:mm:ss.sssss']. I consider it to be a bug-fix.
add more unit tests

How has this been tested?

all unit tests pass (including the new ones)
build the documentation locally and review it
Grammarly

Types of changes

Bug fix
Change to the documentation

Related issue(s):

Checklist:

My code follows the code style of this project,
My change requires a change to the documentation,
I described the modification in the CHANGELOG.md file.

warpech · 2022-04-26T08:37:14Z

@sequba is this ready for review?

sequba · 2022-04-26T10:46:30Z

@sequba is this ready for review?

No, it's not. It requires changes to the documentation.

…umber of seconds' decimal places specified in the timeFormats configuration option

…ing function

…eature/issue-953

github-actions · 2022-09-01T13:50:04Z

Performance comparison of head (`28fde78`) vs base (`c43a7fe`)

                                     testName |  base |  head |  change
-----------------------------------------------------------------------
                                      Sheet A | 505.1 | 508.8 |  +0.73%
                                      Sheet B |   232 | 231.5 |  -0.22%
                                      Sheet T | 276.4 | 263.5 |  -4.67%
                                Column ranges | 682.1 | 692.3 |  +1.50%
Sheet A:  change value, add/remove row/column |    43 |    33 | -23.26%
 Sheet B: change value, add/remove row/column |   318 |   315 |  -0.94%
                   Column ranges - add column |   373 |   226 | -39.41%
                Column ranges - without batch |   650 |   829 | +27.54%
                        Column ranges - batch |   142 |   142 |   0.00%

sequba · 2022-09-01T16:59:56Z

docs/guide/date-and-time-handling.md

-`dateFormats` is a list of formats supported by the parser
-inside HyperFormula. The default format is
-`['MM/DD/YYYY', 'MM/DD/YY']`. The separator is ignored and it can
-be any of the following:  '-' (dash), ' ' (empty space),
-'/' (slash).
-
-Similar to `dateFormats`, `timeFormats` is a list of time formats
-supported by the parser. The default format is
-`['hh:mm', 'hh:mm:ss.sss']`. The only accepted separator is ':' (colon).


It is described in the API ref for these configuration options. No need for duplication.

…Regexp

warpech

Verified by:

running the docs locally
checking the test cases
comparing the PR with the issue and the Slack thread

test/interpreter/function-text.spec.ts

CHANGELOG.md

warpech · 2022-09-02T10:57:43Z

docs/guide/date-and-time-handling.md

-  month: number,
-  day: number,
- }
-```


Can you add a fuller example that is actually a function? This snippet is not clear.

You commented on the removed lines. I also think this code snippet was useless. There is a full example of a custom parseDateTime function in the next section (using Moment.js). Do you think, we need another example?

My bad, sorry.

However, the linked explanations in the docs:

https://hyperformula.handsontable.com/api/interfaces/configparams.html#date-and-time

https://hyperformula.handsontable.com/api/interfaces/configparams.html#stringifydatetime

https://hyperformula.handsontable.com/api/interfaces/configparams.html#stringifyduration

are too shallow, in a way that they doesn't explain the return values.

If you could enhance that in the API reference, I think that would be enough.

Is this ok?

Would be good, but the link to /api/interfaces/globals.html#datetime gives a 404 to me

Sorry about that. It's fixed now.

…time-parsing function.

warpech · 2022-09-05T13:36:38Z

@sequba see my response to #956 (comment)

…ringifyDuration in the API reference

…eature/issue-953

codecov · 2022-09-06T14:35:51Z

Codecov Report

Merging #956 (28fde78) into develop (2805b59) will increase coverage by 0.05%.
The diff coverage is 100.00%.

@@             Coverage Diff             @@
##           develop     #956      +/-   ##
===========================================
+ Coverage    95.74%   95.79%   +0.05%     
===========================================
  Files          161      161              
  Lines        14098    14094       -4     
  Branches      2977     2976       -1     
===========================================
+ Hits         13498    13502       +4     
+ Misses         584      576       -8     
  Partials        16       16

Impacted Files	Coverage Δ
src/Config.ts	`98.00% <ø> (ø)`
src/DateTimeHelper.ts	`95.65% <ø> (ø)`
src/DateTimeDefault.ts	`93.75% <100.00%> (-0.22%)`	⬇️
src/format/format.ts	`99.30% <100.00%> (+5.55%)`	⬆️

sequba and others added 2 commits April 26, 2022 10:59

Add more unit tests for dateFormats param

ad0d133

Fix typo

7938d91

sequba force-pushed the feature/issue-953 branch from be67d90 to 7938d91 Compare April 26, 2022 08:59

sequba marked this pull request as draft April 26, 2022 10:34

sequba self-assigned this Aug 30, 2022

sequba and others added 5 commits August 31, 2022 11:36

Merge branch 'develop' into feature/issue-953

97b951f

Improve the API reference for the dateFormats configuration option

66e47c7

Make time-parsing function return the same number regardless of the n…

0da6767

…umber of seconds' decimal places specified in the timeFormats configuration option

Update the API reference for the timeFormats config parameter

20273be

Add unit tests for dateFormats and timeFormats configuration options

034f9f1

sequba changed the title ~~Add more unit tests for dateFormats param~~ Fix the documentation for the dateFormats and timeFormats configuration options Aug 31, 2022

sequba added 2 commits September 1, 2022 11:03

Add changelog entry about the rounding issue in the default time-pars…

0ce89a6

…ing function

Merge branch 'develop' of github.com:handsontable/hyperformula into f…

b786051

…eature/issue-953

sequba added 2 commits September 1, 2022 18:49

Make date-and-time-handling guide more accurate

71600ed

Add links to date-and-time-handling guide to the API reference

d6a883b

sequba marked this pull request as ready for review September 1, 2022 16:57

sequba commented Sep 1, 2022

View reviewed changes

Adjust defaultStringifyDuration function to change of secondsExtended…

f83b5d5

…Regexp

sequba requested a review from warpech September 1, 2022 18:46

Add more unit tests for TEXTfunction with duration values

7568464

warpech requested changes Sep 2, 2022

View reviewed changes

sequba and others added 2 commits September 4, 2022 20:21

Add a new unit test for TEXT function with time formats

b6993dc

Update changelog - describe the new rounding strategy of the default …

8fd38b9

…time-parsing function.

sequba requested a review from warpech September 4, 2022 18:31

sequba added 2 commits September 5, 2022 18:17

Describe the return values of parseDateTime, stringifyDateTime and st…

51e9884

…ringifyDuration in the API reference

Merge branch 'develop' of github.com:handsontable/hyperformula into f…

dba4edd

…eature/issue-953

sequba added 2 commits September 5, 2022 21:43

Adjust defaultStringifyDateTime to the change of secondsExtendedRegexp

bd4a2d2

Fix 404 in API reference link

e389339

warpech approved these changes Sep 6, 2022

View reviewed changes

Merge branch 'develop' into feature/issue-953

28fde78

sequba merged commit ae64b9f into develop Sep 6, 2022

sequba deleted the feature/issue-953 branch September 6, 2022 14:39

sequba mentioned this pull request Oct 18, 2022

Improve i18n/locale docs for the US clients #1025

Closed

5 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Fix the documentation for the `dateFormats` and `timeFormats` configuration options #956

Fix the documentation for the `dateFormats` and `timeFormats` configuration options #956

sequba commented Apr 5, 2022 •

edited by warpech

Loading

warpech commented Apr 26, 2022

sequba commented Apr 26, 2022

github-actions bot commented Sep 1, 2022 •

edited

Loading

sequba Sep 1, 2022

warpech left a comment

warpech Sep 2, 2022

sequba Sep 4, 2022 •

edited

Loading

warpech Sep 5, 2022 •

edited

Loading

sequba Sep 5, 2022 •

edited

Loading

warpech Sep 6, 2022

sequba Sep 6, 2022

warpech commented Sep 5, 2022

codecov bot commented Sep 6, 2022

Fix the documentation for the dateFormats and timeFormats configuration options #956

Fix the documentation for the dateFormats and timeFormats configuration options #956

Conversation

sequba commented Apr 5, 2022 • edited by warpech Loading

Context

How has this been tested?

Types of changes

Related issue(s):

Checklist:

warpech commented Apr 26, 2022

sequba commented Apr 26, 2022

github-actions bot commented Sep 1, 2022 • edited Loading

Performance comparison of head (28fde78) vs base (c43a7fe)

sequba Sep 1, 2022

Choose a reason for hiding this comment

warpech left a comment

Choose a reason for hiding this comment

warpech Sep 2, 2022

Choose a reason for hiding this comment

sequba Sep 4, 2022 • edited Loading

Choose a reason for hiding this comment

warpech Sep 5, 2022 • edited Loading

Choose a reason for hiding this comment

sequba Sep 5, 2022 • edited Loading

Choose a reason for hiding this comment

warpech Sep 6, 2022

Choose a reason for hiding this comment

sequba Sep 6, 2022

Choose a reason for hiding this comment

warpech commented Sep 5, 2022

codecov bot commented Sep 6, 2022

Codecov Report

Fix the documentation for the `dateFormats` and `timeFormats` configuration options #956

Fix the documentation for the `dateFormats` and `timeFormats` configuration options #956

sequba commented Apr 5, 2022 •

edited by warpech

Loading

github-actions bot commented Sep 1, 2022 •

edited

Loading

Performance comparison of head (`28fde78`) vs base (`c43a7fe`)

sequba Sep 4, 2022 •

edited

Loading

warpech Sep 5, 2022 •

edited

Loading

sequba Sep 5, 2022 •

edited

Loading