Update the assertSucceed reference doc to the public doc #6366
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
|
hsubox76
reviewed
Jun 23, 2022
| @@ -162,7 +162,7 @@ export function assertFails(pr: Promise<any>): Promise<any> { | |||
| } | |||
|
|
|||
| /** | |||
| * Assert the promise to be rejected with a "permission denied" error. | |||
| * Assert the promise to be successful with no Security Rules error. | |||
There was a problem hiding this comment.
I think the additional part after "successful" is confusing and is explained in further detail below. "Assert the promise to be successful" should be good enough here. Thanks!
hsubox76
approved these changes
Jun 23, 2022
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
Update the reference doc for assertSucceed and align it to the public doc.
per: https://firebase.google.com/docs/rules/unit-tests#rut-v2-common-methods
Proposed fix for #6306