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

proc without doc comment gets an unrelated doc comment #9469

Closed
timotheecour opened this issue Oct 23, 2018 · 1 comment
Closed

proc without doc comment gets an unrelated doc comment #9469

timotheecour opened this issue Oct 23, 2018 · 1 comment
Labels
Documentation Generation Related to documentation generation (but not content).

Comments

@timotheecour
Copy link
Member

timotheecour commented Oct 23, 2018

nre.nim defines:

proc toSeq*(pattern: CaptureBounds, default = none(HSlice[int, int])): seq[Option[HSlice[int, int]]] =
  accumulateResult(pattern.items(default))

docs show as (see https://nim-lang.github.io/Nim/nre.html#%24%2CRegexMatch)

proc toSeq(pattern: CaptureBounds; default = none(HSlice[int, int])): seq[
    Option[HSlice[int, int]]] {...}
helps to convert an iterator to a proc. See also sequtils.toSeq which is more hygienic and efficient.

Deprecated since v0.19.2: use toSeq instead

  Source Edit

this is very confusing: the doc comment (and deprecation msg) from accumulateResult somehow is returned as the doc comment of nre.toSeq ; this is wrong

@timotheecour timotheecour added the Documentation Generation Related to documentation generation (but not content). label Oct 23, 2018
@skilchen
Copy link
Contributor

this is another instance of the issue reported in #9432

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

2 participants