summary refs log tree commit diff stats
path: root/lib
diff options
context:
space:
mode:
authorlit <litlighilit@foxmail.com>2024-05-20 19:18:28 +0800
committerGitHub <noreply@github.com>2024-05-20 19:18:28 +0800
commitb838d3ece1e8530f355b5078b2daa96ac01acab5 (patch)
tree45e100069f8cc72298b1817d20caa1b085f867c7 /lib
parentb3b26b2e56df580b1a4190fb28ef4e05f0cff514 (diff)
downloadNim-b838d3ece1e8530f355b5078b2daa96ac01acab5.tar.gz
doc(format): ospaths2,strutils: followup #23560 (#23629)
followup #23560
Diffstat (limited to 'lib')
-rw-r--r--lib/pure/strutils.nim12
-rw-r--r--lib/std/private/ospaths2.nim6
2 files changed, 9 insertions, 9 deletions
diff --git a/lib/pure/strutils.nim b/lib/pure/strutils.nim
index db107e3a5..a9e3df53e 100644
--- a/lib/pure/strutils.nim
+++ b/lib/pure/strutils.nim
@@ -334,9 +334,9 @@ func normalize*(s: string): string {.rtl, extern: "nsuNormalize".} =
 func cmpIgnoreCase*(a, b: string): int {.rtl, extern: "nsuCmpIgnoreCase".} =
   ## Compares two strings in a case insensitive manner. Returns:
   ##
-  ## | 0 if a == b
-  ## | < 0 if a < b
-  ## | > 0 if a > b
+  ## | `0` if a == b
+  ## | `< 0` if a < b
+  ## | `> 0` if a > b
   runnableExamples:
     doAssert cmpIgnoreCase("FooBar", "foobar") == 0
     doAssert cmpIgnoreCase("bar", "Foo") < 0
@@ -354,9 +354,9 @@ func cmpIgnoreStyle*(a, b: string): int {.rtl, extern: "nsuCmpIgnoreStyle".} =
   ##
   ## Returns:
   ##
-  ## | 0 if a == b
-  ## | < 0 if a < b
-  ## | > 0 if a > b
+  ## | `0` if a == b
+  ## | `< 0` if a < b
+  ## | `> 0` if a > b
   runnableExamples:
     doAssert cmpIgnoreStyle("foo_bar", "FooBar") == 0
     doAssert cmpIgnoreStyle("foo_bar_5", "FooBar4") > 0
diff --git a/lib/std/private/ospaths2.nim b/lib/std/private/ospaths2.nim
index a5c0edd9f..bc69ff725 100644
--- a/lib/std/private/ospaths2.nim
+++ b/lib/std/private/ospaths2.nim
@@ -763,9 +763,9 @@ proc cmpPaths*(pathA, pathB: string): int {.
   ## On a case-sensitive filesystem this is done
   ## case-sensitively otherwise case-insensitively. Returns:
   ##
-  ## | 0 if pathA == pathB
-  ## | < 0 if pathA < pathB
-  ## | > 0 if pathA > pathB
+  ## | `0` if pathA == pathB
+  ## | `< 0` if pathA < pathB
+  ## | `> 0` if pathA > pathB
   runnableExamples:
     when defined(macosx):
       assert cmpPaths("foo", "Foo") == 0