Skip to content

apollo_network: simplify README wording per Orwell style rules#14859

Open
dan-starkware wants to merge 1 commit into
mainfrom
claude/orwell-apollo-network-readme
Open

apollo_network: simplify README wording per Orwell style rules#14859
dan-starkware wants to merge 1 commit into
mainfrom
claude/orwell-apollo-network-readme

Conversation

@dan-starkware

Copy link
Copy Markdown
Collaborator

Prose-only edits to crates/apollo_network/README.md, applying Orwell's writing rules. No facts, numbers, or names changed.

  • Cut filler comprehensive / robust / various / capabilities (lines 3, 10, 11, 12, 314, 360).
  • built on top ofbuilt on (line 3).
  • Passive → active: can be extensively configuredYou can configure … (262); is organized into several key moduleshas several modules (303); are properly documentedDocument all public APIs (380).
  • comprehensivethorough (382).

🤖 Generated with Claude Code

https://claude.ai/code/session_01GjrAzEXJmrgsDjg9YSA1c6


Generated by Claude Code

@cursor

cursor Bot commented Jul 21, 2026

Copy link
Copy Markdown

PR Summary

Low Risk
Markdown documentation only; no runtime, security, or API impact.

Overview
Documentation-only edits to crates/apollo_network/README.md—no API, config, or behavior changes.

The intro and feature bullets drop marketing filler (comprehensive, robust, various, capabilities) and shorten phrases like “built on top of” → “built on”. Configuration, architecture, error handling, testing, and contributing sections use direct, active voice (e.g. “You can configure…”, “has several modules”, “Document all public APIs”) instead of passive or inflated wording. “Comprehensive tests” becomes “thorough tests” in contributing guidelines.

Reviewed by Cursor Bugbot for commit 6859b77. Bugbot is set up for automated code reviews on this repo. Configure here.

@reviewable-StarkWare

Copy link
Copy Markdown

This change is Reviewable

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants