Nim is a statically typed compiled systems programming language. It combines successful concepts from mature languages like Python, Ada and Modula. Its design focuses on efficiency, expressiveness, and elegance (in that order of priority).
when a doc comment for a symbol (eg ospaths.lastPathPart) refers to a idx entry, eg baseName:idx:
proc lastPathPart*(path: string): string =
## like ``extractFilename``, but ignores trailing dir separator; aka: `baseName`:idx: in some other languages.
I think this is another issue that theindex.json will fix.
A lot of data has to be left out because the search code can't differentiate the data in html format.
when a doc comment for a symbol (eg
ospaths.lastPathPart
) refers to a idx entry, egbaseName:idx
:it (correctly) ends up in an entry in https://nim-lang.github.io/Nim/theindex.html however, docsearch can't find these idx entries. /cc @rayman22201
Possible Solution
docsearch should work when searching for an idx entry (eg
baseName
should retrieveospaths.lastPathPart
)theindex.html should show the symbol in which the idx entry was mentioned, eg:
should be like other entries:
the idx entry
baseName
should be a link instead of plain text in rendered htmlAdditional Information
foo
:idx: actually work?