Skip to content

Commit

Permalink
Update datetime.js documentation (#1470)
Browse files Browse the repository at this point in the history
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
  • Loading branch information
pixeloution committed Aug 9, 2023
1 parent 57aad3f commit dc26ed2
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion src/datetime.js
Original file line number Diff line number Diff line change
Expand Up @@ -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}
*/
Expand Down

0 comments on commit dc26ed2

Please sign in to comment.