From dc26ed2407ce13fb4d4095bc774acf443ea86ea7 Mon Sep 17 00:00:00 2001 From: Erik Wurzer Date: Tue, 8 Aug 2023 21:17:58 -0500 Subject: [PATCH] Update datetime.js documentation (#1470) the @param as {DateTime} was incorrect and while it technically accepts {string|Invalid}, looking at the code and original documentation lended the impression you'd prefer a string argument for the public API docs --- src/datetime.js | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/datetime.js b/src/datetime.js index 902790945..40c1e6ae1 100644 --- a/src/datetime.js +++ b/src/datetime.js @@ -894,7 +894,7 @@ export default class DateTime { /** * Create an invalid DateTime. - * @param {DateTime} reason - simple string of why this DateTime is invalid. Should not contain parameters or anything else data-dependent + * @param {string} reason - simple string of why this DateTime is invalid. Should not contain parameters or anything else data-dependent. * @param {string} [explanation=null] - longer explanation, may include parameters and other useful debugging information * @return {DateTime} */