Repository navigation
Apollo Librarian / AI Style Review
succeeded
Oct 1, 2026 in 11s
Style Review Completed
The pull request has 1 style issue.
Duration: 3406ms
PR URL: #10349
Review Log: View detailed log
Review Comments: The AI has posted 1 inline comment with suggestions
Summary of changes:
The documentation has been updated to align with the style guide across several sections. Key improvements include standardizing on American English by replacing 'optimise' with 'optimize' in the Language, Products and Features, and Word and Symbol Usage sections. Tone and voice were refined in the Framing and Verb Tense and Voice sections by shifting to the imperative mood and present tense, respectively. Additionally, the Framing Apollo Products section was updated to use simpler language, list item punctuation was removed for fragments in Structural Elements, and unnecessary italics were removed from the Text Formatting section.
Annotations
apollo-librarian / AI Style Review
docs/source/routing/observability/router-telemetry-otel/enabling-telemetry/standard-instruments.mdx#L198
**Framing Apollo Products**: Use simpler language like 'improve' instead of 'optimise'.
**Framing**: Use the imperative 'Use' instead of the passive 'This is used to' for more direct instructions.
**Language**: Use American English spelling ('optimize' instead of 'optimise').
**Products and Features**: The word 'optimise' uses British spelling; use the American spelling 'optimize' for consistency.
**Structural Elements**: Omit ending punctuation for list items that are fragments.
**Text Formatting**: Remove italics from 'optimise' as italics should not be used for general emphasis.
**Verb Tense and Voice**: Use present tense instead of 'is used to'.
**Word and Symbol Usage**: Use 'optimize' instead of 'optimise' for standard spelling.
```suggestion
- `apollo.router.query_planning.plan.non_local_selections` - Histogram of the number non-local selections estimated during query planning traversal. This is used to improve option exploration when planning an operation.
```
Loading