-
Notifications
You must be signed in to change notification settings - Fork 132
Include useKrispNoiseFilter in generated docs, + related improvements #1055
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Conversation
🦋 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 📦
|
…erry/krisp-hook-doc
lukasIO
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
looks good to me, but will defer to @Ocupe
| */ | ||
| trackRef?: TrackReferenceOrPlaceholder; | ||
| /** | ||
| * @internal |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
why would they be internal?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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.
| this._writeBetaWarning(output); | ||
| } | ||
| if (apiItem.releaseTag === ReleaseTag.Alpha) { | ||
| this._writeAlphaWarning(output); |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
nice!
Ocupe
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looking good 👍
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.