Skip to content

Commit bdb2873

Browse files
committed
Minor clarification
1 parent 948a54b commit bdb2873

File tree

2 files changed

+5
-2
lines changed

2 files changed

+5
-2
lines changed

src/Data/Argonaut/Core.purs

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -163,7 +163,8 @@ toBoolean = toJsonType caseJsonBoolean
163163
toNumber :: Json -> Maybe Number
164164
toNumber = toJsonType caseJsonNumber
165165

166-
-- | Convert `Json` to a `String` value, if the `Json` is a string.
166+
-- | Convert `Json` to a `String` value, if the `Json` is a string. To write a
167+
-- | `Json` value to a JSON string, see `stringify`.
167168
toString :: Json -> Maybe String
168169
toString = toJsonType caseJsonString
169170

@@ -230,7 +231,8 @@ jsonSingletonArray j = fromArray [j]
230231
jsonSingletonObject :: String -> Json -> Json
231232
jsonSingletonObject key val = fromObject (Obj.singleton key val)
232233

233-
-- | Converts a `Json` value to a JSON string.
234+
-- | Converts a `Json` value to a JSON string. To retrieve a string from a `Json`
235+
-- | string value, see `fromString`.
234236
foreign import stringify :: Json -> String
235237

236238
foreign import _caseJson

src/Data/Argonaut/Parser.purs

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,5 +7,6 @@ import Data.Function.Uncurried (Fn3, runFn3)
77
foreign import _jsonParser :: forall a. Fn3 (String -> a) (Json -> a) String a
88

99
-- | Parse a JSON string, constructing the `Json` value described by the string.
10+
-- | To convert a string into a `Json` string, see `fromString`.
1011
jsonParser :: String -> Either String Json
1112
jsonParser j = runFn3 _jsonParser Left Right j

0 commit comments

Comments
 (0)