Skip to content

Commit 95887bd

Browse files
authored
Update docs for parse to discourage its use (#25)
* Update docs for `parse` to discourage its use * Use same spelling within the same doc string
1 parent a58a237 commit 95887bd

File tree

1 file changed

+6
-3
lines changed

1 file changed

+6
-3
lines changed

src/Data/JSDate.purs

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -148,10 +148,13 @@ foreign import jsdateLocal
148148
foreign import dateMethodEff :: forall a. Fn2 String JSDate (Effect a)
149149
foreign import dateMethod :: forall a. Fn2 String JSDate a
150150

151-
-- | Attempts to parse a date from a string. The behaviour of this function is
151+
-- | Attempts to parse a date from a string. The behavior of this function is
152152
-- | implementation specific until ES5, so may not always have the same
153-
-- | behaviour for a given string. The RFC2822 and ISO8601 date string formats
154-
-- | should parse consistently.
153+
-- | behavior for a given string. For this reason, it is **strongly** encouraged
154+
-- | that you avoid this function if at all possible.
155+
-- |
156+
-- | If you must use it, the RFC2822 and ISO8601 date string formats should
157+
-- | parse consistently.
155158
-- |
156159
-- | This function is effectful because if no time zone is specified in the
157160
-- | string the current locale's time zone will be used instead.

0 commit comments

Comments
 (0)