Skip to content

Commit 9ce0f80

Browse files
committed
address comments
1 parent 5bb3911 commit 9ce0f80

File tree

1 file changed

+18
-15
lines changed

1 file changed

+18
-15
lines changed

tools/kochdocs.nim

Lines changed: 18 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -129,19 +129,7 @@ doc/manual/var_t_return.rst
129129
doc0 = """
130130
lib/system/threads.nim
131131
lib/system/channels.nim
132-
lib/pure/ioselects/ioselectors_kqueue.nim
133-
lib/pure/ioselects/ioselectors_select.nim
134-
lib/pure/ioselects/ioselectors_poll.nim
135-
lib/pure/ioselects/ioselectors_epoll.nim
136-
lib/posix/posix_macos_amd64.nim
137-
lib/posix/posix_other.nim
138-
lib/posix/posix_nintendoswitch.nim
139-
lib/posix/posix_nintendoswitch_consts.nim
140-
lib/posix/posix_linux_amd64.nim
141-
lib/posix/posix_linux_amd64_consts.nim
142-
lib/posix/posix_other_consts.nim
143-
lib/posix/posix_openbsd_amd64.nim
144-
""".splitWhitespace() # these are include files, `nim doc` would not work, but `nim doc0` does
132+
""".splitWhitespace() # ran by `nim doc0` instead of `nim doc`
145133

146134
withoutIndex = """
147135
lib/wrappers/mysql.nim
@@ -165,7 +153,22 @@ lib/impure/osinfo_win.nim
165153
lib/pure/collections/hashcommon.nim
166154
lib/pure/collections/tableimpl.nim
167155
lib/pure/collections/setimpl.nim
168-
""".splitWhitespace() # these don't produce any useful info even with `nim doc0`
156+
lib/pure/ioselects/ioselectors_kqueue.nim
157+
lib/pure/ioselects/ioselectors_select.nim
158+
lib/pure/ioselects/ioselectors_poll.nim
159+
lib/pure/ioselects/ioselectors_epoll.nim
160+
lib/posix/posix_macos_amd64.nim
161+
lib/posix/posix_other.nim
162+
lib/posix/posix_nintendoswitch.nim
163+
lib/posix/posix_nintendoswitch_consts.nim
164+
lib/posix/posix_linux_amd64.nim
165+
lib/posix/posix_linux_amd64_consts.nim
166+
lib/posix/posix_other_consts.nim
167+
lib/posix/posix_openbsd_amd64.nim
168+
""".splitWhitespace()
169+
# some of these (eg lib/posix/posix_macos_amd64.nim) are include files
170+
# but contain potentially valuable docs on OS-specific symbols (eg OSX) that
171+
# don't end up in the main docs; we ignore these for now.
169172

170173
proc isRelativeTo(path, base: string): bool =
171174
# pending #13212 use os.isRelativeTo
@@ -274,7 +277,7 @@ compiler/plugins/itersgen.nim
274277
if a in bad2: continue
275278
result.add a
276279

277-
const doc = getDocList()
280+
let doc = getDocList()
278281

279282
proc sexec(cmds: openArray[string]) =
280283
## Serial queue wrapper around exec.

0 commit comments

Comments
 (0)