chore(docs): reduce warnings when generating docs #6138
Merged
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
This is a bunch of small miscellaneous fixes that reduce the amount of warnings logged when generating our new docs. The long term goal is to get this list down to 0 warnings, but I'll do it in multiple PRs.
jackfranklin
commented
Jul 2, 2020
| @@ -27,6 +27,9 @@ | |||
| }, | |||
|
|
|||
| "extractorMessageReporting": { | |||
| "ae-internal-missing-underscore": { | |||
| "logLevel": "none" | |||
There was a problem hiding this comment.
this has been disabled because the docs tool wants anything marked as @internal to be prefixed with an underscore. We don't follow this convention (nor do I really want to) so I've disabled this.
jackfranklin
commented
Jul 2, 2020
| @@ -33,7 +33,7 @@ type KeyDescription = Required< | |||
| * {@link Keyboard.up}, and {@link Keyboard.sendCharacter} | |||
| * to manually fire events as if they were generated from a real keyboard. | |||
| * | |||
| * On MacOS, keyboard shortcuts like `⌘ A` -> Select All do not work. | |||
| * On MacOS, keyboard shortcuts like `⌘ A` -\> Select All do not work. | |||
There was a problem hiding this comment.
we need to escape HTML chars in TSDoc comments
jackfranklin
commented
Jul 2, 2020
| /** | ||
| * @public | ||
| */ | ||
| export type MouseButton = 'left' | 'right' | 'middle'; |
There was a problem hiding this comment.
just simplified this type to make it easier to use and document
OrKoN
approved these changes
Jul 2, 2020
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.
This is a bunch of small miscellaneous fixes that reduce the amount of
warnings logged when generating our new docs. The long term goal is to
get this list down to 0 warnings, but I'll do it in multiple PRs.