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.

Sign up for GitHub

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

Jump to bottom

"Diagnostics: reporting errors and lints" #14

Closed
nikomatsakis opened this issue Jan 18, 2018 · 3 comments
Closed

"Diagnostics: reporting errors and lints" #14

nikomatsakis opened this issue Jan 18, 2018 · 3 comments
Labels
E-easy Difficulty: might be a good place for a beginner E-help-wanted Call for participation: extra help is wanted

Comments

@nikomatsakis
Copy link
Contributor

nikomatsakis commented Jan 18, 2018 •
edited by mark-i-m
Loading

We should talk first about:

EDIT(mark-i-m): See #14 (comment)

cc @estebank
@nikomatsakis nikomatsakis mentioned this issue Jan 18, 2018
Closed
20 tasks
@mark-i-m mark-i-m added the E-help-wanted Call for participation: extra help is wanted label Jan 31, 2018
@mark-i-m mark-i-m added the E-medium Difficulty: might require some prior knowledge or code reading label Mar 16, 2018
@mark-i-m mark-i-m mentioned this issue May 22, 2018
Merged
@mark-i-m mark-i-m added E-easy Difficulty: might be a good place for a beginner and removed E-medium Difficulty: might require some prior knowledge or code reading labels Jan 23, 2019
@mark-i-m mark-i-m pinned this issue Jan 23, 2019
Julian-Wollersberger added a commit to Julian-Wollersberger/rustc-guide that referenced this issue May 17, 2019
@Julian-Wollersberger
Renamed the file and title of the diagnostics chapter.
e47e9e2 
When I recently searched for infos in this guide on how to create
a warning, I couldn't find any. Later I found it through rust-lang#14.

The reason was that I didn't know the term 'diagnostics' and that
it is the collective term for errors, warnings and lints.

Renaming the chapter to include the word 'error' should help.
I think also including 'warning' in the title shouldn't be
neccessary, because it's close enought.
Merged
mark-i-m pushed a commit that referenced this issue May 17, 2019
@Julian-Wollersberger @mark-i-m
Renamed the file and title of the diagnostics chapter.
14b243d 
When I recently searched for infos in this guide on how to create
a warning, I couldn't find any. Later I found it through #14.

The reason was that I didn't know the term 'diagnostics' and that
it is the collective term for errors, warnings and lints.

Renaming the chapter to include the word 'error' should help.
I think also including 'warning' in the title shouldn't be
neccessary, because it's close enought.
@mark-i-m mark-i-m unpinned this issue Jun 26, 2019
@Karrq
Copy link

Karrq commented Jul 25, 2019

Looks to me like this issue is currently missing the following:

Errors:

  • How to find an error code and add an extended error
  • Conventions are how the error should be formatted (lowercase letter, etc)
  • when to use span_label etc

Lints:
Nothing? Maybe the section about removing lints present in the rustc Bug Fix Procedure could be added.

@phansch
Copy link
Member

phansch commented Aug 26, 2019 •
edited
Loading

It might also be nice to link to the lint naming recommendations rules from RFC0344

mark-i-m pushed a commit to spastorino/rustc-dev-guide that referenced this issue Jan 2, 2020
@Julian-Wollersberger @mark-i-m
Renamed the file and title of the diagnostics chapter.
90a70a7 
When I recently searched for infos in this guide on how to create
a warning, I couldn't find any. Later I found it through rust-lang#14.

The reason was that I didn't know the term 'diagnostics' and that
it is the collective term for errors, warnings and lints.

Renaming the chapter to include the word 'error' should help.
I think also including 'warning' in the title shouldn't be
neccessary, because it's close enought.
@ehuss ehuss mentioned this issue May 27, 2020
Merged
@rylev
Copy link
Member

rylev commented Jul 4, 2021

Triage: closing. As we now have sections on diagnostics, this issue is a bit too general. I'm closing this in favor of more specific issues.

@rylev rylev closed this as completed Jul 4, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
E-easy Difficulty: might be a good place for a beginner E-help-wanted Call for participation: extra help is wanted
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
5 participants
@nikomatsakis @rylev @phansch @Karrq @mark-i-m