jyapayne/Nim
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

change os.nim doc links to new style (#19102)

Browse source
This commit is contained in:
Andrey Makarov 2021-11-08 15:10:01 +03:00 • committed by GitHub
commit b21eb1ed36
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
8 changed files with 345 additions and 321 deletions
Download patch file Download diff file Expand all files Collapse all files

19
lib/packages/docutils/dochelpers.nim
View file

@ -17,7 +17,9 @@ import rstast
type
LangSymbol* = object ## symbol signature in Nim
symKind*: string ## "proc", "const", etc
symKind*: string ## "proc", "const", "type", etc
symTypeKind*: string ## ""|enum|object|tuple -
## valid only when `symKind == "type"`
name*: string ## plain symbol name without any parameters
generics*: string ## generic parameters (without brackets)
isGroup*: bool ## is LangSymbol a group with overloads?
@ -79,7 +81,14 @@ proc toLangSymbol*(linkText: PRstNode): LangSymbol =
assert linkText.kind in {rnRef, rnInner}
const NimDefs = ["proc", "func", "macro", "method", "iterator",
"template", "converter", "const", "type", "var"]
"template", "converter", "const", "type", "var",
"enum", "object", "tuple"]
template resolveSymKind(x: string) =
if x in ["enum", "object", "tuple"]:
result.symKind = "type"
result.symTypeKind = x
else:
result.symKind = x
type
State = enum
inBeginning
@ -97,7 +106,7 @@ proc toLangSymbol*(linkText: PRstNode): LangSymbol =
if curIdent != "":
case state
of inBeginning: doAssert false, "incorrect state inBeginning"
of afterSymKind: result.symKind = curIdent
of afterSymKind: resolveSymKind curIdent
of beforeSymbolName: doAssert false, "incorrect state beforeSymbolName"
of atSymbolName: result.name = curIdent.nimIdentBackticksNormalize
of afterSymbolName: doAssert false, "incorrect state afterSymbolName"
@ -195,7 +204,7 @@ proc toLangSymbol*(linkText: PRstNode): LangSymbol =
let isPostfixSymKind = i > 0 and i == L - 1 and
result.symKind == "" and s(i) in NimDefs
if isPostfixSymKind: # for links like `foo proc`_
result.symKind = s(i)
resolveSymKind s(i)
else:
case state
of inBeginning:
@ -235,6 +244,8 @@ proc match*(generated: LangSymbol, docLink: LangSymbol): bool =
result = docLink.symKind in ["proc", "func"]
else:
result = generated.symKind == docLink.symKind
if result and docLink.symKind == "type" and docLink.symTypeKind != "":
result = generated.symTypeKind == docLink.symTypeKind
if not result: return
result = generated.name == docLink.name
if not result: return