topic Re: Time Object Documentation Issue in API / CLI Discussion

Time Object Documentation Issue

Bob_Zimmerman — Sun, 30 Apr 2023 15:30:18 GMT

'add time' and 'set time' say they accept a list of objects in the hours-ranges property, but they don't say:

You can only include three objects
Index is optional (and will be populated from the order of the objects if it isn't present)
Index is only allowed to be 0, 1, 2, or 3
Index 0 is allowed, but appears to work like leaving the index out of the object entirely. The object's index is determined by its placement in the hours-ranges list.
If two hours-ranges objects are given the same index, the later object overwrites the first one, even when provided together

Re: Time Object Documentation Issue

PhoneBoy — Mon, 01 May 2023 18:59:59 GMT

Given how time objects are constructed I’m not surprised those limitations exist.
They should be documented, though.
@Omer_Kleinstern

Re: Time Object Documentation Issue

Bob_Zimmerman — Mon, 01 May 2023 19:50:57 GMT

Yeah, I definitely get it. For this, I'm only concerned with documentation for people who come along later.

I think this is the only list I've run into which only accepts a certain number of objects. Also I think it's the only list I've seen where members can be given an index. Not surprising that rare situations have unusual edge cases.

Re: Time Object Documentation Issue

PhoneBoy — Tue, 02 May 2023 13:31:27 GMT

I'm with you on the documentation being accurate. 🙂

Re: Time Object Documentation Issue

Tal_Paz-Fridman — Wed, 03 May 2023 09:16:15 GMT

Thank you for the input; I've opened an issue for R&D to look at it.