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

pragma: foo (eg: benign) should end up in index / documentation #10123

Open
timotheecour opened this issue Dec 29, 2018 · 5 comments
Open

pragma: foo (eg: benign) should end up in index / documentation #10123

timotheecour opened this issue Dec 29, 2018 · 5 comments
Labels
Documentation Generation Related to documentation generation (but not content). Pragmas

Comments

@timotheecour
Copy link
Member

benign ends up all over the place (197 locations) yet we can't find it in nim docs (nor https://nim-lang.github.io/Nim/theindex.html)
it's defined here:lib/system/inclrtl.nim

when defined(nimlocks):
  {.pragma: benign, gcsafe, locks: 0.}
else:
  {.pragma: benign, gcsafe.}

I'm guessing the problem is that {.pragma: foo.} isn't considered an exported symbol, however maybe there's something we could improve here, so that it would still end up in documentation ?

@timotheecour timotheecour added Documentation Generation Related to documentation generation (but not content). Pragmas labels Dec 29, 2018
@timotheecour timotheecour changed the title pragma: foo should end up in index / documentation pragma: foo (eg: benign) should end up in index / documentation Dec 29, 2018
@alaviss
Copy link
Collaborator

alaviss commented Dec 29, 2018

Why would it need to be in the documentation? Is it referenced somewhere?

@timotheecour
Copy link
Member Author

because it appears in so many places (197 for benign), so having it appear in documentation (would be done automatically for pragma definitions) would help anyone working in compiler/stdlib

@Araq
Copy link
Member

Araq commented Dec 30, 2018

System should list it manually in an ## section with the :idx annotation.

@stale
Copy link

stale bot commented Aug 4, 2020

This issue has been automatically marked as stale because it has not had recent activity. If you think it is still a valid issue, write a comment below; otherwise it will be closed. Thank you for your contributions.

@stale stale bot added the stale Staled PR/issues; remove the label after fixing them label Aug 4, 2020
@timotheecour
Copy link
Member Author

see also timotheecour#146, more generally

@timotheecour timotheecour removed the stale Staled PR/issues; remove the label after fixing them label Nov 13, 2020
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). Pragmas
Projects
None yet
Development

No branches or pull requests

3 participants