[docs] Fix context provide decorator api doc #1277
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
A live preview of this PR will be available at the URL(s) below. |
| @@ -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. | |||
There was a problem hiding this comment.
Nit: thoughts about children consumer -> child consumers?
There was a problem hiding this comment.
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!
AndrewJakubowicz
approved these changes
Nov 29, 2023
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
No description provided.