summary refs log tree commit diff stats
path: root/lib/std/syncio.nim
diff options
context:
space:
mode:
authorNan Xiao <nan@chinadtrace.org>2023-08-17 20:26:33 +0800
committerGitHub <noreply@github.com>2023-08-17 20:26:33 +0800
commit019b488e1fcf1782b4452dac8a31965e1a4becae (patch)
tree5b16ee1cd0b9695bb93ec25efea65b4523359c78 /lib/std/syncio.nim
parent2e3d9cdbee6c5ca7c439cfedf8bcb9f0f232a960 (diff)
downloadNim-019b488e1fcf1782b4452dac8a31965e1a4becae.tar.gz
fixes syncio document (#22498)
Diffstat (limited to 'lib/std/syncio.nim')
-rw-r--r--lib/std/syncio.nim4
1 files changed, 2 insertions, 2 deletions
diff --git a/lib/std/syncio.nim b/lib/std/syncio.nim
index a2a5c305b..879301f8a 100644
--- a/lib/std/syncio.nim
+++ b/lib/std/syncio.nim
@@ -359,12 +359,12 @@ proc getOsFileHandle*(f: File): FileHandle =
 
 when defined(nimdoc) or (defined(posix) and not defined(nimscript)) or defined(windows):
   proc setInheritable*(f: FileHandle, inheritable: bool): bool =
-    ## control whether a file handle can be inherited by child processes. Returns
+    ## Controls whether a file handle can be inherited by child processes. Returns
     ## `true` on success. This requires the OS file handle, which can be
     ## retrieved via `getOsFileHandle <#getOsFileHandle,File>`_.
     ##
     ## This procedure is not guaranteed to be available for all platforms. Test for
-    ## availability with `declared() <system.html#declared,untyped>`.
+    ## availability with `declared() <system.html#declared,untyped>`_.
     when SupportIoctlInheritCtl:
       result = c_ioctl(f, if inheritable: FIONCLEX else: FIOCLEX) != -1
     elif defined(freertos) or defined(zephyr):