feat: improve JSDocs for RenderOptions (#909)

Co-authored-by: Sebastian Silbermann <[email protected]>

Author: ImADrafter

types/index.d.ts

@@ -34,10 +34,42 @@ export interface RenderOptions<
   Q extends Queries = typeof queries,
   Container extends Element | DocumentFragment = HTMLElement,
 > {
+  /**
+   * 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,
+   *  it will not be appended to the document.body automatically.
+   *
+   *  For example: If you are unit testing a `<tbody>` element, it cannot be a child of a div. In this case, you can
+   *  specify a table as the render container.
+   *
+   *  @see https://testing-library.com/docs/react-testing-library/api/#container
+   */
   container?: Container
+  /**
+   * Defaults to the container if the container is specified. Otherwise `document.body` is used for the default. This is used as
+   *  the base element for the queries as well as what is printed when you use `debug()`.
+   *
+   *  @see https://testing-library.com/docs/react-testing-library/api/#baseelement
+   */
   baseElement?: Element
+  /**
+   * If `hydrate` is set to `true`, then it will render with `ReactDOM.hydrate`. This may be useful if you are using server-side
+   *  rendering and use ReactDOM.hydrate to mount your components.
+   *
+   *  @see https://testing-library.com/docs/react-testing-library/api/#hydrate)
+   */
   hydrate?: boolean
+  /**
+   * Queries to bind. Overrides the default set from DOM Testing Library unless merged.
+   *
+   *  @see https://testing-library.com/docs/react-testing-library/api/#queries
+   */
   queries?: Q
+  /**
+   * Pass a React Component as the wrapper option to have it rendered around the inner element. This is most useful for creating
+   *  reusable custom render functions for common data providers. See setup for examples.
+   *
+   *  @see https://testing-library.com/docs/react-testing-library/api/#wrapper
+   */
   wrapper?: React.ComponentType
 }