Add response body fields - #8158
Style Review Completed
The pull request has 7 style issues.
Duration: 606ms
PR URL: #8158
Review Comments: The AI has posted 7 inline comments with suggestions
Summary of changes:
The documentation changes include: making statements more direct and authoritative, using imperative verbs for procedural headings, replacing "allow" with "enable" for new functionality, avoiding "allows for" and "towards" for more direct phrasing, and correcting the usage of "while" to mean "although".
Annotations
Check notice on line 45 in docs/source/routing/observability/telemetry/instrumentation/selectors.mdx
apollo-librarian / AI Style Review
docs/source/routing/observability/telemetry/instrumentation/selectors.mdx#L45
The parenthetical is less authoritative. A direct statement about the performance impact is clearer and more aligned with an opinionated voice.
```suggestion
| <code>response_body</code> | Yes | | JSON Path into the router response body data. Using this selector can impact performance. |
```
Check notice on line 46 in docs/source/routing/observability/telemetry/instrumentation/selectors.mdx
apollo-librarian / AI Style Review
docs/source/routing/observability/telemetry/instrumentation/selectors.mdx#L46
The parenthetical is less authoritative. A direct statement about the performance impact is clearer and more aligned with an opinionated voice.
```suggestion
| <code>response_errors</code> | Yes | | JSON Path into the router response body errors. Using this selector can impact performance. |
```
apollo-librarian / AI Style Review
docs/source/routing/observability/telemetry/instrumentation/selectors.mdx#L199
For headings in sections that describe how to do something, use imperative verbs instead of gerunds.
```suggestion
### Capture the router response body
```
apollo-librarian / AI Style Review
docs/source/routing/observability/telemetry/instrumentation/selectors.mdx#L201
Avoid using the word 'allow'. Use 'enable' when a feature provides new functionality.
```suggestion
The <code>response_body</code> selector enables you to access the response body in the telemetry
```
apollo-librarian / AI Style Review
docs/source/routing/observability/telemetry/instrumentation/selectors.mdx#L214
For headings in sections that describe how to do something, use imperative verbs instead of gerunds.
```suggestion
### Capture router response errors
```
apollo-librarian / AI Style Review
docs/source/routing/observability/telemetry/instrumentation/selectors.mdx#L216
Avoid using 'allows for' and 'towards'. The suggested phrasing is more direct and uses 'toward' as per the style guide.
```suggestion
The <code>response_errors</code> selector provides a more granular way to gather specific error
```
apollo-librarian / AI Style Review
docs/source/routing/observability/telemetry/instrumentation/selectors.mdx#L218
Avoid using 'while' to mean 'although' or to contrast phrases that are not happening simultaneously. 'But' is clearer in this context.
```suggestion
but still provides relevant error information.
```