Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[minor] nim doc renders generic badly (extra ;): template default[T; ](t: typedesc[T]): T + bad formatting #8488

Closed
1 of 2 tasks
timotheecour opened this issue Jul 31, 2018 · 1 comment
Labels
Documentation Generation Related to documentation generation (but not content).

Comments

@timotheecour
Copy link
Member

timotheecour commented Jul 31, 2018

  • extra ;
    nim doc test.nim
template default*[T](t: typedesc[T]): T =
  ## returns default value for type ``T``, and can work at compile time
  defaultImpl[T]()
#renders as:
template default[T; ](t: typedesc[T]): T
#instead of:
template default[T](t: typedesc[T]): T
  • bad formatting:
proc test1*[T](x: T) : T =
  ## A test function v2
  runnableExamples:
    doAssert test1(12) == 12
  return x

shows as:

doAssert test2(12) ==
    12

instead of

doAssert test1(12) == 12

image

@timotheecour timotheecour changed the title [minor] nim doc renders generic badly (extra ;): template default[T; ](t: typedesc[T]): T [minor] nim doc renders generic badly (extra ;): template default[T; ](t: typedesc[T]): T + bad formatting Aug 2, 2018
@timotheecour timotheecour added the Documentation Generation Related to documentation generation (but not content). label Oct 30, 2018
@timotheecour
Copy link
Member Author

2nd issue has been fixed
1st issue remains: now renders as:

image

marking as WONTFIX for 1st issue

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Documentation Generation Related to documentation generation (but not content).
Projects
None yet
Development

No branches or pull requests

1 participant