From a88bdc0e32fcd53c31ee173459a87225c9f99185 Mon Sep 17 00:00:00 2001 From: Takeshi Shimada Date: Tue, 28 Oct 2025 02:39:27 +0900 Subject: [PATCH] docs: Remove subjective and exaggerated expressions from documentation MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit 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 --- README.md | 2 +- Sources/Flow/Flow.docc/CoreConcepts.md | 16 ++++++++-------- Sources/Flow/Flow.docc/Flow.md | 2 +- 3 files changed, 10 insertions(+), 10 deletions(-) diff --git a/README.md b/README.md index a8f6084..3b97d5b 100644 --- a/README.md +++ b/README.md @@ -6,7 +6,7 @@ [日本語版](README_jp.md) -A type-safe state management library for SwiftUI applications. Flow provides a unidirectional data flow architecture with full support for Swift 6 Approachable Concurrency. +A type-safe state management library for SwiftUI applications. Flow provides a unidirectional data flow architecture and supports Swift 6 Approachable Concurrency.

Flow Architecture Diagram diff --git a/Sources/Flow/Flow.docc/CoreConcepts.md b/Sources/Flow/Flow.docc/CoreConcepts.md index 12e3937..9b41b80 100644 --- a/Sources/Flow/Flow.docc/CoreConcepts.md +++ b/Sources/Flow/Flow.docc/CoreConcepts.md @@ -8,7 +8,7 @@ This guide explains Flow's design philosophy and key features. You'll learn abou ## Unidirectional Data Flow -Flow adopts unidirectional data flow. All state changes occur through actions, making it easy to track how state evolves. +Flow adopts unidirectional data flow. All state changes occur through actions, allowing you to track how state evolves. ![Flow Architecture Diagram](flow-diagram.svg) @@ -47,12 +47,12 @@ struct CounterView: View { } ``` -- State scope is clear (same lifecycle as the view) -- No need to manage global state +- State scope matches the view lifecycle +- Reduces the need to manage global state ### Result-Returning Actions -Actions can return results through `ActionTask`. The result type (`ActionResult`) can be freely defined for each Feature. +Actions can return results through `ActionTask`. The result type (`ActionResult`) can be defined for each Feature. In this example, a child view returns a selection result to the parent, which handles navigation: @@ -121,7 +121,7 @@ This implementation provides: - `ChildFeature` returns selection results to the parent via `ActionResult` - `ParentView` receives results through the `onSelect` callback - Parent controls side effects like navigation -- Everything stays within the view tree, making dependencies easy to track +- Everything stays within the view tree, allowing dependencies to be tracked See for more details. @@ -152,7 +152,7 @@ A Swift 6 feature that allows setting default actor isolation for an entire modu .defaultIsolation(MainActor.self) ``` -This ensures all operations run on the MainActor, with **data races caught at compile time**. A data race occurs when multiple threads access the same memory simultaneously and at least one performs a write. +This ensures all operations run on the MainActor, with **compile-time data race detection**. A data race occurs when multiple threads access the same memory simultaneously and at least one performs a write. ```swift import Flow @@ -174,7 +174,7 @@ func handle() -> ActionHandler { } ``` -- Thread-safety guaranteed +- Provides thread-safety - Native `async/await` support ### Observable Actions @@ -202,7 +202,7 @@ func handle() -> ActionHandler { } ``` -- Observe all actions in one place +- Observe actions in one place - Use for logging, analytics, and debugging ## Next Steps diff --git a/Sources/Flow/Flow.docc/Flow.md b/Sources/Flow/Flow.docc/Flow.md index 46700d4..1756363 100644 --- a/Sources/Flow/Flow.docc/Flow.md +++ b/Sources/Flow/Flow.docc/Flow.md @@ -1,6 +1,6 @@ # ``Flow`` -A library for managing state in SwiftUI applications in a type-safe way. Flow provides a unidirectional data flow architecture with full support for Swift 6 Approachable Concurrency. +A library for managing state in SwiftUI applications in a type-safe way. Flow provides a unidirectional data flow architecture and supports Swift 6 Approachable Concurrency. ## Key Features