Include useKrispNoiseFilter in generated docs, + related improvements #1055
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
🦋 Changeset detectedLatest commit: ae92d3a The changes in this PR will be included in the next version bump. This PR includes changesets to release 7 packages
Not sure what this means? Click here to learn what changesets are. Click here if you're a maintainer who wants to add another changeset to this PR |
size-limit report 📦
|
bcherry
changed the title
…erry/krisp-hook-doc
lukasIO
approved these changes
Dec 19, 2024
| */ | ||
| trackRef?: TrackReferenceOrPlaceholder; | ||
| /** | ||
| * @internal |
There was a problem hiding this comment.
why would they be internal?
There was a problem hiding this comment.
this was the easiest way to just leave it out of the docs. this comes from the closed-source underlying krisp SDK, so there's no good way to document this parameter. the actual values available to tweak here also seem unlikely to be useful, it's just debugging flags basically? I don't feel strongly about it I just thought it's easier to exclude it from the docs.
| @@ -209,6 +208,9 @@ export class MarkdownDocumenter { | |||
| if (apiItem.releaseTag === ReleaseTag.Beta) { | |||
| this._writeBetaWarning(output); | |||
| } | |||
| if (apiItem.releaseTag === ReleaseTag.Alpha) { | |||
| this._writeAlphaWarning(output); | |||
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.
The main issue here is the krisp hook was excluded from generated docs because it's not actually in the react package index.d.ts. I decided the most straightforward thing to do is include it in generated docs anyways alongside everything else. I improved its docs a bit and upgraded it from alpha to beta.
While working on this I found and fixed the following additional issues:
@packagetag for tsdoc so we can override the import path for the krisp hook@betatag into a callout instead of a paragraph (and some text edits)@alphatag just like the@betatag hasoptions.abc). this still has room for improvement@returndirective is currently ignored entirely in favor of a generated signature. To improve docs, I've added the return description, if supplied, alongside the generated code.