Commit 402dee9

committed

docs: reword descriptions

1 parent 79527a9 commit 402dee9Copy full SHA for 402dee9

File tree

-7

lines changed

projects/testing-library/src/lib
- models.ts
- user-events
  - index.ts
  - type.ts

-7

lines changed

Lines changed: 5 additions & 3 deletions

Original file line number	Diff line number	Diff line change
`@@ -8,15 +8,17 @@ export type RenderResultQueries<Q extends Queries = typeof queries> = { [P in ke`
`8`	`8`	`export interface RenderResult extends RenderResultQueries, FireObject, UserEvents {`
`9`	`9`	`/**`
`10`	`10`	`* @description`
`11`		`- * The HTML of the rendered component`
	`11`	`+ * The containing DOM node of your rendered Angular Component.`
	`12`	`+ * This is a regular DOM node, so you can call container.querySelector etc. to inspect the children.`
`12`	`13`	`*/`
`13`	`14`	`container: HTMLElement;`
`14`	`15`	`/**`
`15`	`16`	`* @description`
`16`		`- * Prints out the component's HTML with syntax highlighting`
	`17`	`+ * Prints out the component's DOM with syntax highlighting.`
	`18`	`+ * Accepts an optional parameter, to print out a specific DOM node.`
`17`	`19`	`*`
`18`	`20`	`* @param`
`19`		`- * element: The to be printed HTML element, if not provided it will log the whole component's HTML`
	`21`	`+ * element: The to be printed HTML element, if not provided it will log the whole component's DOM`
`20`	`22`	`*/`
`21`	`23`	`debug: (element?: HTMLElement) => void;`
`22`	`24`	`/**`

Lines changed: 3 additions & 3 deletions

Original file line number	Diff line number	Diff line change
`@@ -5,11 +5,11 @@ import { createSelectOptions } from './selectOptions';`
`5`	`5`	`export interface UserEvents {`
`6`	`6`	`/**`
`7`	`7`	`* @description`
`8`		`- * Types a value in an input field just like the user would do`
	`8`	`+ * Types a value in an input field with the same interactions as the user would do.`
`9`	`9`	`*`
`10`	`10`	`* @argument`
`11`	`11`	`* element: HTMLElement - the form field to type in`
`12`		`- * value: string - the value to type in`
	`12`	`+ * value: string \| number - the value to type in`
`13`	`13`	`*`
`14`	`14`	`* @example`
`15`	`15`	`* component.type(component.getByLabelText('Firstname'), 'Tim')`
`@@ -20,7 +20,7 @@ export interface UserEvents {`
`20`	`20`
`21`	`21`	`/**`
`22`	`22`	`* @description`
`23`		`- * Select an option(s) from a select just like the user would do`
	`23`	`+ * Select an option(s) from a select field with the same interactions as the user would do.`
`24`	`24`	`*`
`25`	`25`	`* @argument`
`26`	`26`	`* element: HTMLElement - the select box to select an option in`

Lines changed: 1 addition & 1 deletion

Original file line number	Diff line number	Diff line change
`@@ -9,7 +9,7 @@ function wait(time) {`
`9`	`9`	`export interface TypeOptions {`
`10`	`10`	`/**`
`11`	`11`	`* @description`
`12`		`- * Write the text at once rather than on character at a time`
	`12`	`+ * Types the text at once rather than on character at a time`
`13`	`13`	`*`
`14`	`14`	`* @default`
`15`	`15`	`* false`

Comments

(0)