API Extractor is throwing some warnings on some doc comments, which also show up in downstream code that references this package.
Cleaned up those issues.
👩💻 Reviewer Notes
Note that the change in tooltip fixes ae-setter-with-docs which only wants comments on the getter. Removing the comment from the setter caused it to be removed from the Fields list in the README. Since that property has split visibility it's probably cleaner like this anyway.
✅ Checklist
General
[x] I have included a change request file using $ yarn change
[ ] I have added tests for my changes.
[ ] I have tested my changes.
[ ] I have updated the project documentation to reflect my changes.
[x] I have read the CONTRIBUTING documentation and followed the standards for this project.
Pull Request
📖 Description
API Extractor is throwing some warnings on some doc comments, which also show up in downstream code that references this package.
Cleaned up those issues.
👩💻 Reviewer Notes
Note that the change in
tooltip
fixesae-setter-with-docs
which only wants comments on the getter. Removing the comment from the setter caused it to be removed from theFields
list in theREADME
. Since that property has split visibility it's probably cleaner like this anyway.✅ Checklist
General
$ yarn change