chore: Enabled tsdoc error checking #1459
Merged
+523
−526
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
hiranya911
added a commit
that referenced
this pull request
Oct 13, 2021
egilmorez
reviewed
Oct 13, 2021
| @@ -53,8 +53,8 @@ export class AppCheckApiClient { | |||
| /** | |||
| * Exchange a signed custom token to App Check token | |||
| * | |||
| * @param customToken The custom token to be exchanged. | |||
| * @param appId The mobile App ID. | |||
| * @param customToken - The custom token to be exchanged. | |||
There was a problem hiding this comment.
Are these single dashes, double dashes, or an "em dash?"
Curious if this is our choice our a Rushstack standard.
There was a problem hiding this comment.
I am also curious about the dashes. Are we okay with parameters appearing with a dash in the docs?
There was a problem hiding this comment.
This is the TSDoc syntax. See examples in https://tsdoc.org/
It's a single dash, and you will get an error if you don't include it. They also do not appear in the generated markdown, as API Extractor renders parameters in tables. For example: https://github.com/firebase/firebase-admin-node/blob/modular-sdk-docs/docgen/markdown/firebase-admin.app-check.appcheck.md
lahirumaramba
approved these changes
Oct 13, 2021
egilmorez
approved these changes
Oct 14, 2021
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.
Diff on the generated docs: 438aa88