Skip to content

[docs] Fix context provide decorator api doc #1277

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Nov 29, 2023
Merged

[docs] Fix context provide decorator api doc #1277

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion packages/lit-dev-content/site/docs/v2/data/context.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -369,7 +369,7 @@ The `ValueType` type parameter is the type of value that can be provided by this

### `@provide()`

A property decorator that adds a ContextConsumer controller to the component which will try and retrieve a value for the property via the Context API.
A property decorator that adds a ContextProvider controller to the component making it respond to any `context-request` events from its children consumer.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nit: thoughts about children consumer -> child consumers?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I took it straight from the JSDoc here
https://github.com/lit/lit/blob/f60a3a2c994f41fc3df1bd8a76451ea185b66e11/packages/context/src/lib/decorators/provide.ts#L19-L20

While I don't oppose to the new wording itself, I think it's minor enough that I'd rather keep it in sync with what's on the source code. Thanks for the suggestion though!

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Great call!


**Import**:

Expand Down
2 changes: 1 addition & 1 deletion packages/lit-dev-content/site/docs/v3/data/context.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -367,7 +367,7 @@ The `ValueType` type parameter is the type of value that can be provided by this

### `@provide()`

A property decorator that adds a ContextConsumer controller to the component which will try and retrieve a value for the property via the Context API.
A property decorator that adds a ContextProvider controller to the component making it respond to any `context-request` events from its children consumer.

**Import**:

Expand Down