Skip to content

Commit 94b04f2

Browse files
ImADraftereps1lon
andcommitted
Update types/index.d.ts
Co-authored-by: Sebastian Silbermann <[email protected]>
1 parent 039da4e commit 94b04f2

File tree

1 file changed

+5
-6
lines changed

1 file changed

+5
-6
lines changed

types/index.d.ts

+5-6
Original file line numberDiff line numberDiff line change
@@ -34,23 +34,22 @@ export interface RenderOptions<
3434
Q extends Queries = typeof queries,
3535
Container extends Element | DocumentFragment = HTMLElement
3636
> {
37-
/** By default, React Testing Library will create a div and append that div to the document.body and this is
38-
* where your React component will be rendered. If you provide your own HTMLElement container via this option,
37+
/** By default, React Testing Library will create a div and append that div to the document.body. Your React component will be rendered in the created div. If you provide your own HTMLElement container via this option,
3938
* it will not be appended to the document.body automatically.
4039
*
41-
* For example: If you are unit testing a tablebody element, it cannot be a child of a div. In this case, you can
40+
* For example: If you are unit testing a `<tbody>` element, it cannot be a child of a div. In this case, you can
4241
* specify a table as the render container.
4342
*
4443
* @link https://testing-library.com/docs/react-testing-library/api/#container
4544
*/
4645
container?: Container
47-
/** If the container is specified, then this defaults to that, otherwise this defaults to document.body. This is used as
48-
* the base element for the queries as well as what is printed when you use debug().
46+
/** Defaults to the container if the container is specified. Otherwise `document.body` is used for the default. This is used as
47+
* the base element for the queries as well as what is printed when you use `debug()`.
4948
*
5049
* @link https://testing-library.com/docs/react-testing-library/api/#baseelement
5150
*/
5251
baseElement?: Element
53-
/** If hydrate is set to true, then it will render with ReactDOM.hydrate. This may be useful if you are using server-side
52+
/** If `hydrate` is set to `true`, then it will render with `ReactDOM.hydrate`. This may be useful if you are using server-side
5453
* rendering and use ReactDOM.hydrate to mount your components.
5554
*
5655
* @link https://testing-library.com/docs/react-testing-library/api/#hydrate)

0 commit comments

Comments
 (0)