Extensions TSDoc edits #1982
Merged
Extensions TSDoc edits #1982
Conversation
This file contains 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
ifielker
approved these changes
Nov 17, 2022
src/extensions/extensions-api.ts
Outdated
| @@ -16,14 +16,22 @@ | |||
| */ | |||
|
|
|||
| /** | |||
| * SettableProcessingState represents all the Processing states that can be set on an ExtensionInstance's runtimeData. | |||
| * SettableProcessingState represents all the Processing states that can be set | |||
| * on an ExtensionInstance's runtimeData. | |||
There was a problem hiding this comment.
ExtensionInstance should be 2 words?
ifielker
approved these changes
Nov 17, 2022
ifielker
approved these changes
Nov 17, 2022
src/extensions/extensions-api.ts
Outdated
| @@ -16,14 +16,22 @@ | |||
| */ | |||
|
|
|||
| /** | |||
| * SettableProcessingState represents all the Processing states that can be set on an ExtensionInstance's runtimeData. | |||
| * SettableProcessingState represents all the processing states that can be set | |||
There was a problem hiding this comment.
I think we can remove SettableProcessingState from here and just say Represents all the Processing states...
Suggested change
| * SettableProcessingState represents all the processing states that can be set | |
| * Represents all the processing states that can be set |
src/extensions/extensions-api.ts
Outdated
| @@ -16,14 +16,22 @@ | |||
| */ | |||
|
|
|||
| /** | |||
| * SettableProcessingState represents all the Processing states that can be set on an ExtensionInstance's runtimeData. | |||
| * SettableProcessingState represents all the processing states that can be set | |||
| * on an Extension instance's runtimeData. | |||
There was a problem hiding this comment.
Should runtimeData back-ticked?
lahirumaramba
approved these changes
Nov 17, 2022
|
Thank you, @kevinthecheung ! LGTM! |
ifielker
approved these changes
Nov 17, 2022
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.
Hey there! So you want to contribute to a Firebase SDK?
Before you file this pull request, please read these guidelines:
Discussion
If not, go file an issue about this before creating a pull request to discuss.
Testing
API Changes
us make Firebase APIs better, please propose your change in an issue so that we
can discuss it together.