shoot forgot

planetis-m · Apr 15, 2024 · 13dfc0d · 13dfc0d
1 parent acc9719
commit 13dfc0d
Show file tree

Hide file tree

Showing 2 changed files with 13 additions and 11 deletions.
diff --git a/docs/sorted.html b/docs/sorted.html
@@ -121,7 +121,7 @@ <h1><a class="toc-backref" href="#12">Procs</a></h1>
  <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
  <dd>
 
-
+ The equality comparison for SortedJsonTree is faster than the one for JsonTree.
  <a href="https://github.com/planetis-m/jsonpak/tree/main/src/jsonpak/sorted.nim#L56" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
 <a href="https://github.com/planetis-m/jsonpak/edit/main/src/jsonpak/sorted.nim#L56" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
 
@@ -134,7 +134,9 @@ <h1><a class="toc-backref" href="#12">Procs</a></h1>
  <dt><pre><span class="Keyword">proc</span> <a href="#deduplicate%2CSortedJsonTree"><span class="Identifier">deduplicate</span></a><span class="Other">(</span><span class="Identifier">tree</span><span class="Other">:</span> <span class="Keyword">var</span> <a href="sorted.html#SortedJsonTree"><span class="Identifier">SortedJsonTree</span></a><span class="Other">)</span> {.<span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
  <dd>
 
-
+ <p>Deduplicates keys in <tt class="docutils literal"><span class="pre"><span class="Identifier">tree</span></span></tt> recursively. If duplicate keys are found, only the last occurrence of each key is kept.</p>
+<p>The deduplication is performed in-place.</p>
+
  <a href="https://github.com/planetis-m/jsonpak/tree/main/src/jsonpak/sorted.nim#L106" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
 <a href="https://github.com/planetis-m/jsonpak/edit/main/src/jsonpak/sorted.nim#L106" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
 
@@ -148,7 +150,7 @@ <h1><a class="toc-backref" href="#12">Procs</a></h1>
  <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
  <dd>
 
-
+ Sorts all the keys of <tt class="docutils literal"><span class="pre"><span class="Identifier">tree</span></span></tt> recursively, ensuring that the resulting tree has its keys in lexicographic order.
  <a href="https://github.com/planetis-m/jsonpak/tree/main/src/jsonpak/sorted.nim#L34" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
 <a href="https://github.com/planetis-m/jsonpak/edit/main/src/jsonpak/sorted.nim#L34" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
 
@@ -166,7 +168,7 @@ <h1><a class="toc-backref" href="#12">Procs</a></h1>
  <div class="twelve-columns footer">
  <span class="nim-sprite"></span>
  <br>
- <small style="color: var(--hint);">Made with Nim. Generated: 2024-04-15 09:12:11 UTC</small>
+ <small style="color: var(--hint);">Made with Nim. Generated: 2024-04-15 09:19:19 UTC</small>
  </div>
  </div>
  </div>

diff --git a/src/jsonpak/sorted.nim b/src/jsonpak/sorted.nim
@@ -32,8 +32,8 @@ proc rawSorted(result: var JsonTree; tree: JsonTree, n: NodePos) =
  result.nodes.add tree.nodes[curr.int]
 
 proc sorted*(tree: JsonTree): SortedJsonTree {.inline.} =
- # Sorts all the keys of `tree` recursively, ensuring that
- # the resulting tree has its keys in lexicographic order.
+ ## Sorts all the keys of `tree` recursively, ensuring that
+ ## the resulting tree has its keys in lexicographic order.
  privateAccess(JsonTree)
  result = JsonTree(nodes: newSeqOfCap[Node](tree.nodes.len)).SortedJsonTree
  rawSorted(JsonTree(result), tree, rootNodeId)
@@ -54,7 +54,7 @@ proc rawTest(tree, value: JsonTree, n: NodePos): bool =
  return true
 
 proc `==`*(a, b: SortedJsonTree): bool {.inline.} =
- # The equality comparison for SortedJsonTree is faster than the one for JsonTree.
+ ## The equality comparison for SortedJsonTree is faster than the one for JsonTree.
  privateAccess(JsonTree)
  if JsonTree(a).nodes.len != JsonTree(b).nodes.len:
  return false
@@ -104,9 +104,9 @@ proc rawDeduplicate(tree: var JsonTree, n: NodePos, parents: var seq[PatchPos])
  discard
 
 proc deduplicate*(tree: var SortedJsonTree) =
- # Deduplicates keys in `tree` recursively. If duplicate keys are found,
- # only the last occurrence of each key is kept.
- #
- # The deduplication is performed in-place.
+ ## Deduplicates keys in `tree` recursively. If duplicate keys are found,
+ ## only the last occurrence of each key is kept.
+ ##
+ ## The deduplication is performed in-place.
  var parents: seq[PatchPos] = @[]
  rawDeduplicate(JsonTree(tree), rootNodeId, parents)