r-lib / clock

A Date-Time Library for R
https://clock.r-lib.org
Other
97 stars 4 forks source link

Use of `...` incorrectly forbidden #307

Closed wurli closed 1 year ago

wurli commented 1 year ago

I noticed a small issue with date_format() and as_zoned_time() where the use of ... is actually required, but is forbidden in the documentation.

DavisVaughan commented 1 year ago

I see how that could be confusing but I think I prefer the documentation as it is now for simplicity.

On the help page of the generic, the dots are technically passed on to methods, but I never think of the generic as what is actually "called", I think of the method as being what you call

Screen Shot 2022-11-12 at 8 58 12 AM

On the help page of the method after you click through by clicking the dates (Date) link above, the dots really must be empty

Screen Shot 2022-11-12 at 8 58 47 AM

This is the case for every generic/method combination that I have in clock, I really do force the ... to be empty in every method to enforce named optional arguments, so I feel like this inconsistency is ok to get users used to the idea that the dots are typically empty