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

document error message terms #3363

Closed
jesse99 opened this issue Sep 3, 2012 · 5 comments
Closed

document error message terms #3363

jesse99 opened this issue Sep 3, 2012 · 5 comments

Comments

@jesse99
Copy link
Contributor

jesse99 commented Sep 3, 2012

Error messages and the documentation needs to be kept in sync. In particular terms used by error messages (e.g. "outer comment") need to be documented.

@graydon
Copy link
Contributor

graydon commented Jun 12, 2013

re-nominating for reconsideration. this is either too vague (and should close), or else we need a mechanism to check it.

possible mechanism: a docterm!(str) macro that does nothing but can be mechanically extracted and compared to docs. Other possibilities include mechanisms associated with error message translation / message catalogues. It might make sense for rustdoc to support definition-extraction in general.

see also #2092 , where we might want a way to link external doc fragments (as in a FAQ) to error messages.

@graydon
Copy link
Contributor

graydon commented Jun 20, 2013

accepted for production-ready milestone

@graydon
Copy link
Contributor

graydon commented Jun 20, 2013

language being well-defined is #1, diagnostics being well-defined is #5

@thestinger
Copy link
Contributor

This is a good candidate for being a metabug, but more specific issues need to be reported.

@pnkfelix
Copy link
Member

closing as non-actionable.

RalfJung pushed a commit to RalfJung/rust that referenced this issue Mar 9, 2024
Rustup

This should finally work again :)
RalfJung pushed a commit to RalfJung/rust that referenced this issue Mar 9, 2024
Rustup

This should finally work again :)
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

No branches or pull requests

4 participants