Skip to content

Commit 5d8ec5b

Browse files
committed
Reword docs to satisfy Vale's contraction and wordiness rules
1 parent 6def395 commit 5d8ec5b

2 files changed

Lines changed: 2 additions & 2 deletions

File tree

‎docs/CHANGELOG.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ nav_order: 6
1212

1313
* Resolve `# Template Dependency: SomeComponent` declarations naming a component that hasn't included `ViewComponent::ExperimentallyCacheable`.
1414

15-
The declaration was previously dropped: the class name was emitted to the Digestor verbatim, which looked for a template at that path, found none, and logged `Couldn't find template for digesting: SomeComponent`. That made the escape hatch unusable for exactly the dependencies it exists for, since a component reached through a local variable or a helper module is often one you don't control and can't add the module to. Naming a component in a declaration now digests it, whether or not it opted in.
15+
The declaration was previously dropped: the class name was emitted to the Digestor verbatim, which looked for a template at that path, found none, and logged `Couldn't find template for digesting: SomeComponent`. That made the escape hatch unusable for exactly the dependencies it exists for, since a component reached through a local variable or a helper module is often one you don't control and can't add the module to. Naming a component in a declaration now digests it, opted in or not.
1616

1717
*Erik Axel Nielsen*
1818

‎docs/guide/caching.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -187,7 +187,7 @@ The same works in a template, where the branch is often the more natural place f
187187
<%= render component.new(post: @post) %>
188188
```
189189

190-
A declared component doesn't have to include `ViewComponent::ExperimentallyCacheable` itself. Naming it is enough for its template, Ruby class, sidecar files, and superclasses to be digested, which matters because the components this escape hatch exists for are often ones you don't control.
190+
A declared component doesn't have to include `ViewComponent::ExperimentallyCacheable` itself. The declaration alone gets its template, Ruby class, sidecar files, and superclasses digested, which matters because the components this escape hatch exists for are often ones you don't control.
191191

192192
## Caveats
193193

0 commit comments

Comments
 (0)