Improve error-writing documentation#120
Draft
Reefact wants to merge 8 commits into
Draft
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
This PR separates stable error documentation from runtime message guidance so developers can write precise, safe, and diagnosable errors without navigating overlapping pages. It also turns the best-practices page and FAQ into concise entry points that direct readers to the focused guides.
Type of change
Changes
ShortMessage,DetailedMessage, andDiagnosticMessage.ErrorContext, RFC 9457 mapping, and localization with concrete good/bad examples.Testing
dotnet build FirstClassErrors.slndotnet test FirstClassErrors.slnFirstClassErrors.Analyzers.UnitTests)No build or test command was run because this PR changes Markdown documentation only. The branch diff and cross-page navigation were reviewed manually.
Documentation
doc/updateddoc/README.fr.md) updated if user-facing behavior changedThe French counterparts of every changed or added English page are included.
doc/README.fr.mditself did not require a change because the existing Writing Errors Guide remains the entry point and now links to the new message guide.Related issues
None.