Skip to content

docs: Remove subjective and exaggerated expressions from documentation#7

Merged
takeshishimada merged 1 commit intomainfrom
docs/remove-subjective-expressions
Oct 29, 2025
Merged

docs: Remove subjective and exaggerated expressions from documentation#7
takeshishimada merged 1 commit intomainfrom
docs/remove-subjective-expressions

Conversation

@takeshishimada
Copy link
Copy Markdown
Contributor

Summary

This PR removes subjective and exaggerated expressions from the documentation (README and DocC files) to maintain a more objective and professional tone.

Changes Made

Replaced subjective expressions with objective language:

  • ❌ "full support for" → ✅ "supports"
  • ❌ "Thread-safety guaranteed" → ✅ "Provides thread-safety"
  • ❌ "making it easy to track" → ✅ "allowing you to track"
  • ❌ "State scope is clear" → ✅ "State scope matches the view lifecycle"
  • ❌ "No need to manage global state" → ✅ "Reduces the need to manage global state"
  • ❌ "can be freely defined" → ✅ "can be defined"
  • ❌ "making dependencies easy to track" → ✅ "allowing dependencies to be tracked"
  • ❌ "data races caught at compile time" → ✅ "compile-time data race detection"
  • ❌ "Observe all actions" → ✅ "Observe actions"

Files Modified

  • README.md
  • Sources/Flow/Flow.docc/Flow.md
  • Sources/Flow/Flow.docc/CoreConcepts.md

Rationale

The original expressions like "guaranteed", "full support", and "easy" are subjective marketing terms that can be perceived as exaggerated claims. This change improves documentation quality by:

  • Using factual, verifiable language
  • Maintaining professional technical writing standards
  • Avoiding absolute claims that may not hold in all edge cases
  • Aligning with the more measured tone of the Japanese documentation

Test Plan

  • Documentation builds successfully
  • All technical information remains accurate
  • Tone is consistent across all documentation files

🤖 Generated with Claude Code

Replace subjective expressions with more objective language across README and DocC files:
- "full support" → "supports"
- "guaranteed" → "provides"
- "easy to track" → "allowing to track"
- "No need" → "Reduces the need"
- "all actions" → "actions"
- "clear" → "matches the view lifecycle"
- "freely defined" → "defined"
- "data races caught at compile time" → "compile-time data race detection"

This improves documentation clarity and maintains a professional, objective tone.

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude <noreply@anthropic.com>
@github-actions github-actions Bot added the documentation Improvements or additions to documentation label Oct 27, 2025
@takeshishimada takeshishimada merged commit f2aa49d into main Oct 29, 2025
9 checks passed
@takeshishimada takeshishimada deleted the docs/remove-subjective-expressions branch October 31, 2025 08:54
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant