diff options
| author | Dominik Picheta <dominikpicheta@googlemail.com> | 2016-06-02 13:46:52 +0100 |
|---|---|---|
| committer | Dominik Picheta <dominikpicheta@googlemail.com> | 2016-06-02 13:46:52 +0100 |
| commit | b4d0ea663481a386ec21e828d0d0209f8ff51f83 (patch) | |
| tree | 811821829d6c40e20f02b859062390d2fda9fdc1 /lib | |
| parent | c5b47628e4538969b9605279ec648b7dc1456418 (diff) | |
| parent | 91506451039ec8fd07363da948baa7a4f1680368 (diff) | |
| download | Nim-b4d0ea663481a386ec21e828d0d0209f8ff51f83.tar.gz | |
Merge pull request #4263 from abudden/4255-json-doc
Corrected comments in json pretty/ugly procedures (fixes #4255).
Diffstat (limited to 'lib')
| -rw-r--r-- | lib/pure/json.nim | 6 |
1 files changed, 4 insertions, 2 deletions
diff --git a/lib/pure/json.nim b/lib/pure/json.nim index d310a6ed7..cea7a1e90 100644 --- a/lib/pure/json.nim +++ b/lib/pure/json.nim @@ -1009,7 +1009,7 @@ proc toPretty(result: var string, node: JsonNode, indent = 2, ml = true, result.add("null") proc pretty*(node: JsonNode, indent = 2): string = - ## Converts `node` to its JSON Representation, with indentation and + ## Returns a JSON Representation of `node`, with indentation and ## on multiple lines. result = "" toPretty(result, node, indent) @@ -1019,7 +1019,9 @@ proc toUgly*(result: var string, node: JsonNode) = ## regard for human readability. Meant to improve ``$`` string ## conversion performance. ## - ## This provides higher efficiency than the ``toPretty`` procedure as it + ## JSON representation is stored in the passed `result` + ## + ## This provides higher efficiency than the ``pretty`` procedure as it ## does **not** attempt to format the resulting JSON to make it human readable. var comma = false case node.kind: |