You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
bug 3: lib.rst is incomplete and should be automatically checked for completeness
we should trigger a CI error if a stdlib module is missing from lib.rst (https://nim-lang.github.io/Nim/lib.html)
we can maintain a (small) blacklist of modules that should not be mentioned there, if needed.
bug 1: search box gives no hits
the search box in https://nim-lang.github.io/Nim/lib.html gives no hits for these:
even though https://nim-lang.github.io/Nim/prelude.html exists and
include std/prelude
worksbug 2: theindex.html gives no hits
https://nim-lang.github.io/Nim/theindex.html gives no hits for:
bug 3: lib.rst is incomplete and should be automatically checked for completeness
we should trigger a CI error if a stdlib module is missing from lib.rst (https://nim-lang.github.io/Nim/lib.html)
we can maintain a (small) blacklist of modules that should not be mentioned there, if needed.
for example:
io
is missing currently from https://nim-lang.github.io/Nim/lib.html#pure-libraries-automatic-importshighlite
is missing (it should be some index, either stdlib's or, if we turn docutils into a proper nimble package, its own index for docutils, see fix #16973 ; nim doc now shows correct, canonical import name in title #16999 (comment))bug 3: master index + per-package indexes
there should be a page where we index all modules in nim repo (or more generally in some git repository with multiple nimble packages).
each index has its own page, with a theindex.html and corresponding search box; we almost have that already:
we can have:
bug 4 (easy)
in https://nim-lang.github.io/Nim/lib.html#pure-libraries-automatic-imports,
bug 5: nim language index
we also need a language index, where you can search for builtin pragmas (eg:
inject
), keywords (eg:template
,proc
, tokens (eg:"""
,'
etc)just as all other indexes (stdlib, compiler, fusion) it'd have it's own index, and would also be searchable in the master index
the index href would point to wherever the term is defined (most likely to an entry in the manual), possibly via a
:idx:
linkAdditional Information
1.5.1 28221e8
ideally these should be fixed with a generic approach that works with other repositories, not use hard coded lists
The text was updated successfully, but these errors were encountered: