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

[docgen] export causes duplicate doc generation #17016

Closed
konsumlamm opened this issue Feb 11, 2021 · 2 comments
Closed

[docgen] export causes duplicate doc generation #17016

konsumlamm opened this issue Feb 11, 2021 · 2 comments
Labels
Documentation Generation Related to documentation generation (but not content).

Comments

@konsumlamm
Copy link
Contributor

If export is used on a public binding (for example a proc), the documentation for it is generated twice.

Example

proc test*() = discard

export test

Current Output

Expected Output

Additional Information

This bug appears in the random module (see #16953 (comment)), where the documentation for initRand(int64) is generated twice.

$ nim -v
Nim Compiler Version 1.5.1 [Linux: amd64]
Compiled at 2021-02-08
Copyright (c) 2006-2021 by Andreas Rumpf

git hash: c548f97241c9f0da8f9442c07b99dd9d6adf225a
@timotheecour
Copy link
Member

timotheecour commented Feb 11, 2021

for motivation (since some would object provided example is contrived), a use case is when you already have an exported overload, and then conditionally export another overload.

relevant past PR: #13123

@timotheecour timotheecour added the Documentation Generation Related to documentation generation (but not content). label Feb 11, 2021
@ringabout
Copy link
Member

fixed by #23074

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

3 participants