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

Fixes #7586: Adds documentation for hints #8625

Merged
merged 1 commit into from
Aug 14, 2018

Conversation

drslump
Copy link
Contributor

@drslump drslump commented Aug 13, 2018

Fixes #7586

Not sure about what all the hints mean, I've added them nonetheless so users can experiment on their own, it at least saves them from greping the compiler sources. But anyhow, if there are some that should be considered as private to the compiler I can remove them. And of course, please feel free to provide the missing explanations :)

@dom96
Copy link
Contributor

dom96 commented Aug 14, 2018

Nice! Thank you for taking the time to compose this :)

@dom96 dom96 merged commit 9a7e6be into nim-lang:devel Aug 14, 2018
@timotheecour
Copy link
Member

timotheecour commented Aug 14, 2018

  • @drslump Would be great if documentation could be autogenerated from documentation comments of hints, to keep things DRY
  • these documentation comments could also appear in nim --hints:list

@timotheecour
Copy link
Member

timotheecour commented Aug 25, 2018

@drslump while your PR improves the status quo, a better fix would be to auto-generate from each hint's documentation comments ; would be more DRY and doesn't get out of date (since it's compiler code it should be doable currently; but more generally for user code could be done via #8516 )

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants