feat: improve JSDocs for RenderOptions #909
Conversation
|
This pull request is automatically built and testable in CodeSandbox. To see build info of the built libraries, click here or the icon next to each commit SHA. Latest deployment of this branch, based on commit 4f419ec:
|
types/index.d.ts
Outdated
| /** If the container is specified, then this defaults to that, otherwise this defaults to document.body. This is used as | ||
| * the base element for the queries as well as what is printed when you use debug(). | ||
| * | ||
| * [BaseElement](https://testing-library.com/docs/react-testing-library/api/#baseelement) |
There was a problem hiding this comment.
Not a fan of these non-descriptive links. What do you think about just
| * [BaseElement](https://testing-library.com/docs/react-testing-library/api/#baseelement) | |
| * @see https://testing-library.com/docs/react-testing-library/api/#baseelement |
There was a problem hiding this comment.
The think with @see is that you loose the hyperlink on the hint :(
Will check. I was under the impression VSCode did make these clickable.
There was a problem hiding this comment.
Just checked the links and they all work without any JSDoc tags. Will just use @see tags.
Co-authored-by: Sebastian Silbermann <[email protected]>
ImADrafter
force-pushed
the
improve-render-options-jsdocs
branch
from
624b86c to
94b04f2
Compare
eps1lon
changed the title
Codecov Report
@@ Coverage Diff @@
## main #909 +/- ##
=========================================
Coverage 100.00% 100.00%
=========================================
Files 4 4
Lines 140 140
Branches 28 28
=========================================
Hits 140 140 Continue to review full report at Codecov.
|
|
@ImADrafter Much appreciated, thanks! @all-contributors add @ImADrafter for docs |
|
I've put up a pull request to add @ImADrafter! 🎉 |
|
🎉 This PR is included in version 12.1.0 🎉 The release is available on:
Your semantic-release bot 📦🚀 |
What: Improve JS docs for type definitions, including JSDocs for RenderOptions.
Im just not sure if
docscommit type is the proper for this oneWhy: While using react-testing library, sometimes you will need to review the docs. By filling props description with just a brief stract of the docs, the library would be easier to use for IDEs with JSDoc support, specially for newcommers.
How: JSDocs syntax
Checklist:
docs site