[@firebase/rules-unit-testing] confusing documentation #6306
Description
The documentation of assertSucceeds and assertFails are "Assert the promise to be rejected with a "permission denied" error", are success and failure the same thing?
/**
* Assert the promise to be rejected with a "permission denied" error.
*
* Useful to assert a certain request to be denied by Security Rules. See example below.
* This function recognizes permission-denied errors from Database, Firestore, and Storage JS SDKs.
*
* @param pr - the promise to be asserted
* @returns a Promise that is fulfilled if pr is rejected with "permission denied". If pr is
* rejected with any other error or resolved, the returned promise rejects.
* @public
* @example
* ```javascript
* const unauthed = testEnv.unauthenticatedContext();
* await assertFails(get(doc(unauthed.firestore(), '/private/doc'), { ... });
* ```
*/
export function assertFails(pr: Promise<any>): Promise<any> {/**
* Assert the promise to be rejected with a "permission denied" error.
*
* This is a no-op function returning the passed promise as-is, but can be used for documentational
* purposes in test code to emphasize that a certain request should succeed (e.g. allowed by rules).
*
* @public
* @example
* ```javascript
* const alice = testEnv.authenticatedContext('alice');
* await assertSucceeds(get(doc(alice.firestore(), '/doc/readable/by/alice'), { ... });
* ```
*/
export function assertSucceeds<T>(pr: Promise<T>): Promise<T> {