search

nim-lang / Nim

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).
https://nim-lang.org
Other
16.44k stars 1.47k forks source link

nim doc fails to parse line #21436

Closed noahehall closed 1 year ago

noahehall commented 1 year ago

Description

##[
- *.nims
]##
08:31 PM (develop *% u=) 
$ nim doc nim_doc_fails.nim 
Hint: used config file '/home/poop/.choosenim/toolchains/nim-1.6.10/config/nim.cfg' [Conf]
Hint: used config file '/home/poop/.choosenim/toolchains/nim-1.6.10/config/config.nims' [Conf]
Hint: used config file '/home/poop/.choosenim/toolchains/nim-1.6.10/config/nim.cfg' [Conf]
Hint: used config file '/home/poop/.choosenim/toolchains/nim-1.6.10/config/config.nims' [Conf]
Hint: used config file '/home/poop/.choosenim/toolchains/nim-1.6.10/config/nimdoc.cfg' [Conf]
.........................................................
/home/poop/git/foss/nim/nim_doc_fails.nim(1, 8) Error: '*' expected
lineinfos.nim(289)       raiseRecoverableError
Error: unhandled exception: '*' expected [ERecoverableError]

Nim Version

$ nim -v Nim Compiler Version 1.6.10 [Linux: amd64] Compiled at 2022-11-21 Copyright (c) 2006-2021 by Andreas Rumpf

git hash: f1519259f85cbdf2d5ff617c6a5534fcd2ff6942 active boot switches: -d:release

Current Output

No response

Expected Output

Possible Solution

Additional Information

No response

ire4ever1190 commented 1 year ago

Another solution is to escape the * so that the markdown parser skips it

##[
- \*.nims
]##
ringabout commented 1 year ago

Duplicate of https://github.com/nim-lang/Nim/issues/19607

noahehall commented 1 year ago

@ire4ever1190 thanks for the work around