Skip to content

[docs] Unbloat WS0001 analyzer rule documentation - #84

Merged
github-actions[bot] merged 1 commit into
mainfrom
docs/unbloat-ws0001-8e2ad2db928cbf81
Oct 12, 2026
Merged

github-actions[bot] merged 1 commit into
mainfrom
docs/unbloat-ws0001-8e2ad2db928cbf81

Conversation

@github-actions

Copy link
Copy Markdown
Contributor

Summary

Improved clarity and conciseness of docs/rules/WS0001.md by removing redundancy and simplifying explanations.

Changes Made

Line reduction: 40 → 37 lines (7.5% reduction, 3 lines removed)

Specific improvements:

  1. Cause section: Combined redundant platform-behavior descriptions into one concise sentence

    • Before: Separate explanations for "eliminate allocation" and "per-call parsing"
    • After: Single statement covering both optimizations with platform guidance inline
  2. Code example formatting: Reduced example bloat

    • Changed multi-line method to expression-bodied form (more concise)
    • Easier to scan and understand the issue quickly
  3. How to Fix section:

    • Changed verbose "net9.0+/net10.0" to concise "net9.0+"
    • Added context to platform guidance (e.g., "source-generator interceptor optimizes calls")
    • Clarified net8.0 instructions with "refactor" terminology
    • Improved pragma comment example (changed "Startup message" to "Non-critical" for clarity)

Preservation

✅ All essential technical information preserved
✅ Code examples remain complete and accurate
✅ Platform-specific guidance still clear
✅ No links or critical details removed

Reviewability

The changes are small and surgical—easy to verify that bloat was removed without losing substance. The documentation is now faster to scan while maintaining all necessary technical guidance.

🗜️ Compressed by Documentation Unbloat

To install this agentic workflow, run

gh aw add githubnext/agentics/workflows/unbloat-docs.md@1c6668b751c51af8571f01204ceffb19362e0f66
  • expires on Oct 14, 2026, 9:27 PM UTC

Remove redundant explanations and condense platform-specific guidance:
- Simplified Cause section to combine both platform behaviors
- Changed verbose 'net9.0+/net10.0' to concise 'net9.0+'
- Reduced example code bloat (multi-line to expression-bodied)
- Clarified manual fix with 'refactor' terminology
- Changed 'startup message' example to 'Non-critical'

Line reduction: 40 → 37 lines (7.5% reduction, 3 lines removed)
All essential information preserved.

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
@github-actions github-actions Bot added automation documentation Improvements or additions to documentation labels Oct 12, 2026
@github-actions
github-actions Bot marked this pull request as ready for review October 12, 2026 21:27
@github-actions
github-actions Bot merged commit d653fce into main Oct 12, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

automation documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

0 participants