[docs] condense WS0001 rule documentation#13
Draft
github-actions[bot] wants to merge 1 commit into
Draft
Conversation
Remove prose bloat in the Rule description and When to suppress sections: - Merge three paragraphs into two in Rule description - Simplify net8/net9 explanation to a single combined sentence - Condense Cause prose to one line - Tighten How to fix violations lead-in to one line - Reduce When to suppress description from two lines to one 63 → 50 lines (-20.6%), 281 → 229 words (-18.5%) Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
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.
Reduces prose bloat in
docs/rules/WS0001.mdwhile preserving all technical information.File improved:
docs/rules/WS0001.mdChanges made:
[LoggerMessage]reference instead of "source-generated[LoggerMessage]pattern". The net8/net9 behaviour is combined into a single sentence using "On net9.0+ ... On net8.0 ..." contrast.witness.Loggerusing one of the templated ... extension methods" with the direct "calls a templated ... extension method".Metrics:
All essential information (cause pattern, performance rationale, net8 vs net9+ behaviour, fix procedure, suppression guidance) is preserved.