Skip to content

Commit f32243f

Browse files
committed
simplify weird args markdown bolding
1 parent 6ac2724 commit f32243f

File tree

122 files changed

+422
-422
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

122 files changed

+422
-422
lines changed

docs/api/actions/check.mdx

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -27,14 +27,14 @@ This element must be an `<input>` with type `checkbox` or `radio`.
2727

2828
### Usage
2929

30-
**<Icon name="check-circle" color="green" /> Correct Usage**
30+
<Icon name="check-circle" color="green" /> **Correct Usage**
3131

3232
```javascript
3333
cy.get('[type="checkbox"]').check() // Check checkbox element
3434
cy.get('[type="radio"]').first().check() // Check first radio element
3535
```
3636

37-
**<Icon name="exclamation-triangle" color="red" /> Incorrect Usage**
37+
<Icon name="exclamation-triangle" color="red" /> **Incorrect Usage**
3838

3939
```javascript
4040
cy.check('[type="checkbox"]') // Errors, cannot be chained off 'cy'
@@ -43,15 +43,15 @@ cy.get('p:first').check() // Errors, '.get()' does not yield checkbox or radio
4343

4444
### Arguments
4545

46-
**<Icon name="angle-right" /> value** **_(String)_**
46+
<Icon name="angle-right" /> **value _(String)_**
4747

4848
Value of checkbox or radio that should be checked.
4949

50-
**<Icon name="angle-right" /> values** **_(Array)_**
50+
<Icon name="angle-right" /> **values _(Array)_**
5151

5252
Values of checkboxes or radios that should be checked.
5353

54-
**<Icon name="angle-right" /> options** **_(Object)_**
54+
<Icon name="angle-right" /> **options _(Object)_**
5555

5656
Pass in an options object to change the default behavior of `.check()`.
5757

docs/api/actions/clear.mdx

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -23,15 +23,15 @@ An alias for [`.type('{selectall}{backspace}')`](/api/commands/type)
2323

2424
### Usage
2525

26-
**<Icon name="check-circle" color="green" /> Correct Usage**
26+
<Icon name="check-circle" color="green" /> **Correct Usage**
2727

2828
```javascript
2929
cy.get('[type="text"]').clear() // Clear text input
3030
cy.get('textarea').type('Hi!').clear() // Clear textarea
3131
cy.focused().clear() // Clear focused input/textarea
3232
```
3333

34-
**<Icon name="exclamation-triangle" color="red" /> Incorrect Usage**
34+
<Icon name="exclamation-triangle" color="red" /> **Incorrect Usage**
3535

3636
```javascript
3737
cy.clear() // Errors, cannot be chained off 'cy'
@@ -41,7 +41,7 @@ cy.clock().clear() // Errors, 'clock' does not yield DOM elements
4141

4242
### Arguments
4343

44-
**<Icon name="angle-right" /> options** **_(Object)_**
44+
<Icon name="angle-right" /> **options _(Object)_**
4545

4646
Pass in an options object to change the default behavior of `.clear()`.
4747

docs/api/actions/click.mdx

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -21,15 +21,15 @@ chain further commands that rely on the subject after `.click()`.
2121

2222
### Usage
2323

24-
**<Icon name="check-circle" color="green" /> Correct Usage**
24+
<Icon name="check-circle" color="green" /> **Correct Usage**
2525

2626
```javascript
2727
cy.get('.btn').click() // Click on button
2828
cy.focused().click() // Click on el with focus
2929
cy.contains('Welcome').click() // Click on first el containing 'Welcome'
3030
```
3131

32-
**<Icon name="exclamation-triangle" color="red" /> Incorrect Usage**
32+
<Icon name="exclamation-triangle" color="red" /> **Incorrect Usage**
3333

3434
```javascript
3535
cy.click('.btn') // Errors, cannot be chained off 'cy'
@@ -38,7 +38,7 @@ cy.window().click() // Errors, 'window' does not yield DOM element
3838

3939
### Arguments
4040

41-
**<Icon name="angle-right" /> position** **_(String)_**
41+
<Icon name="angle-right" /> **position _(String)_**
4242

4343
The position where the click should be issued. The `center` position is the
4444
default position. Valid positions are `topLeft`, `top`, `topRight`, `left`,
@@ -49,15 +49,15 @@ default position. Valid positions are `topLeft`, `top`, `topRight`, `left`,
4949
alt="cypress-command-positions-diagram"
5050
/>
5151

52-
**<Icon name="angle-right" /> x** **_(Number)_**
52+
<Icon name="angle-right" /> **x _(Number)_**
5353

5454
The distance in pixels from the element's left to issue the click.
5555

56-
**<Icon name="angle-right" /> y** **_(Number)_**
56+
<Icon name="angle-right" /> **y _(Number)_**
5757

5858
The distance in pixels from the element's top to issue the click.
5959

60-
**<Icon name="angle-right" /> options** **_(Object)_**
60+
<Icon name="angle-right" /> **options _(Object)_**
6161

6262
Pass in an options object to change the default behavior of `.click()`.
6363

docs/api/actions/dblclick.mdx

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -21,15 +21,15 @@ chain further commands that rely on the subject after `.dblclick()`.
2121

2222
### Usage
2323

24-
**<Icon name="check-circle" color="green" /> Correct Usage**
24+
<Icon name="check-circle" color="green" /> **Correct Usage**
2525

2626
```javascript
2727
cy.get('button').dblclick() // Double click on button
2828
cy.focused().dblclick() // Double click on el with focus
2929
cy.contains('Welcome').dblclick() // Double click on first el containing 'Welcome'
3030
```
3131

32-
**<Icon name="exclamation-triangle" color="red" /> Incorrect Usage**
32+
<Icon name="exclamation-triangle" color="red" /> **Incorrect Usage**
3333

3434
```javascript
3535
cy.dblclick('button') // Errors, cannot be chained off 'cy'
@@ -38,7 +38,7 @@ cy.window().dblclick() // Errors, 'window' does not yield DOM element
3838

3939
### Arguments
4040

41-
**<Icon name="angle-right" /> position** **_(String)_**
41+
<Icon name="angle-right" /> **position _(String)_**
4242

4343
The position where the double click should be issued. The `center` position is
4444
the default position. Valid positions are `topLeft`, `top`, `topRight`, `left`,
@@ -49,15 +49,15 @@ the default position. Valid positions are `topLeft`, `top`, `topRight`, `left`,
4949
alt="cypress-command-positions-diagram"
5050
/>
5151

52-
**<Icon name="angle-right" /> x** **_(Number)_**
52+
<Icon name="angle-right" /> **x _(Number)_**
5353

5454
The distance in pixels from the element's left to issue the double click.
5555

56-
**<Icon name="angle-right" /> y** **_(Number)_**
56+
<Icon name="angle-right" /> **y _(Number)_**
5757

5858
The distance in pixels from the element's top to issue the double click.
5959

60-
**<Icon name="angle-right" /> options** **_(Object)_**
60+
<Icon name="angle-right" /> **options _(Object)_**
6161

6262
Pass in an options object to change the default behavior of `.dblclick()`.
6363

docs/api/actions/rightclick.mdx

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -29,15 +29,15 @@ related events such as `contextmenu`.
2929

3030
### Usage
3131

32-
**<Icon name="check-circle" color="green" /> Correct Usage**
32+
<Icon name="check-circle" color="green" /> **Correct Usage**
3333

3434
```javascript
3535
cy.get('.menu').rightclick() // Right click on .menu
3636
cy.focused().rightclick() // Right click on el with focus
3737
cy.contains('Today').rightclick() // Right click on first el containing 'Today'
3838
```
3939

40-
**<Icon name="exclamation-triangle" color="red" /> Incorrect Usage**
40+
<Icon name="exclamation-triangle" color="red" /> **Incorrect Usage**
4141

4242
```javascript
4343
cy.rightclick('button') // Errors, cannot be chained off 'cy'
@@ -46,7 +46,7 @@ cy.window().rightclick() // Errors, 'window' does not yield DOM element
4646

4747
### Arguments
4848

49-
**<Icon name="angle-right" /> position** **_(String)_**
49+
<Icon name="angle-right" /> **position _(String)_**
5050

5151
The position where the right click should be issued. The `center` position is
5252
the default position. Valid positions are `topLeft`, `top`, `topRight`, `left`,
@@ -57,15 +57,15 @@ the default position. Valid positions are `topLeft`, `top`, `topRight`, `left`,
5757
alt="cypress-command-positions-diagram"
5858
/>
5959

60-
**<Icon name="angle-right" /> x** **_(Number)_**
60+
<Icon name="angle-right" /> **x _(Number)_**
6161

6262
The distance in pixels from the element's left to issue the right click.
6363

64-
**<Icon name="angle-right" /> y** **_(Number)_**
64+
<Icon name="angle-right" /> **y _(Number)_**
6565

6666
The distance in pixels from the element's top to issue the right click.
6767

68-
**<Icon name="angle-right" /> options** **_(Object)_**
68+
<Icon name="angle-right" /> **options _(Object)_**
6969

7070
Pass in an options object to change the default behavior of `.rightclick()`.
7171

docs/api/actions/scrollintoview.mdx

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -17,13 +17,13 @@ chain further commands that rely on the subject after `.scrollIntoView()`.
1717

1818
### Usage
1919

20-
**<Icon name="check-circle" color="green" /> Correct Usage**
20+
<Icon name="check-circle" color="green" /> **Correct Usage**
2121

2222
```javascript
2323
cy.get('footer').scrollIntoView() // Scrolls 'footer' into view
2424
```
2525

26-
**<Icon name="exclamation-triangle" color="red" /> Incorrect Usage**
26+
<Icon name="exclamation-triangle" color="red" /> **Incorrect Usage**
2727

2828
```javascript
2929
cy.scrollIntoView('footer') // Errors, cannot be chained off 'cy'
@@ -32,7 +32,7 @@ cy.window().scrollIntoView() // Errors, 'window' does not yield DOM element
3232

3333
### Arguments
3434

35-
**<Icon name="angle-right" /> options** **_(Object)_**
35+
<Icon name="angle-right" /> **options _(Object)_**
3636

3737
Pass in an options object to change the default behavior of `.scrollIntoView()`.
3838

docs/api/actions/scrollto.mdx

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -26,22 +26,22 @@ cy.scrollTo(x, y, options)
2626

2727
### Usage
2828

29-
**<Icon name="check-circle" color="green" /> Correct Usage**
29+
<Icon name="check-circle" color="green" /> **Correct Usage**
3030

3131
```javascript
3232
cy.scrollTo(0, 500) // Scroll the window 500px down
3333
cy.get('.sidebar').scrollTo('bottom') // Scroll 'sidebar' to its bottom
3434
```
3535

36-
**<Icon name="exclamation-triangle" color="red" /> Incorrect Usage**
36+
<Icon name="exclamation-triangle" color="red" /> **Incorrect Usage**
3737

3838
```javascript
3939
cy.title().scrollTo('My App') // Errors, 'title' does not yield DOM element
4040
```
4141

4242
### Arguments
4343

44-
**<Icon name="angle-right" /> position** **_(String)_**
44+
<Icon name="angle-right" /> **position _(String)_**
4545

4646
A specified position to scroll the window or element to. Valid positions are
4747
`topLeft`, `top`, `topRight`, `left`, `center`, `right`, `bottomLeft`, `bottom`,
@@ -52,17 +52,17 @@ and `bottomRight`.
5252
alt="cypress-command-positions-diagram"
5353
/>
5454

55-
**<Icon name="angle-right" /> x** **_(Number, String)_**
55+
<Icon name="angle-right" /> **x _(Number, String)_**
5656

5757
The distance in pixels from window/element's left or percentage of the
5858
window/element's width to scroll to.
5959

60-
**<Icon name="angle-right" /> y** **_(Number, String)_**
60+
<Icon name="angle-right" /> **y _(Number, String)_**
6161

6262
The distance in pixels from window/element's top or percentage of the
6363
window/element's height to scroll to.
6464

65-
**<Icon name="angle-right" /> options** **_(Object)_**
65+
<Icon name="angle-right" /> **options _(Object)_**
6666

6767
Pass in an options object to change the default behavior of `cy.scrollTo()`.
6868

docs/api/actions/select.mdx

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -19,13 +19,13 @@ chain further commands that rely on the subject after `.select()`.
1919

2020
### Usage
2121

22-
**<Icon name="check-circle" color="green" /> Correct Usage**
22+
<Icon name="check-circle" color="green" /> **Correct Usage**
2323

2424
```javascript
2525
cy.get('select').select('user-1') // Select the 'user-1' option
2626
```
2727

28-
**<Icon name="exclamation-triangle" color="red" /> Incorrect Usage**
28+
<Icon name="exclamation-triangle" color="red" /> **Incorrect Usage**
2929

3030
```javascript
3131
cy.select('John Adams') // Errors, cannot be chained off 'cy'
@@ -34,16 +34,16 @@ cy.clock().select() // Errors, 'clock' does not yield a <select> element
3434

3535
### Arguments
3636

37-
**<Icon name="angle-right" /> value** **_(String, Number)_**
37+
<Icon name="angle-right" /> **value _(String, Number)_**
3838

3939
The `value`, `index`, or text content of the `<option>` to be selected.
4040

41-
**<Icon name="angle-right" /> values** **_(Array)_**
41+
<Icon name="angle-right" /> **values _(Array)_**
4242

4343
An array of `values`, `indexes`, or text contents of the `<option>`s to be
4444
selected.
4545

46-
**<Icon name="angle-right" /> options** **_(Object)_**
46+
<Icon name="angle-right" /> **options _(Object)_**
4747

4848
Pass in an options object to change the default behavior of `.select()`.
4949

docs/api/actions/selectfile.mdx

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ chain further commands that rely on the subject after `.selectFile()`.
2020

2121
### Usage
2222

23-
**<Icon name="check-circle" color="green" /> Correct Usage**
23+
<Icon name="check-circle" color="green" /> **Correct Usage**
2424

2525
```javascript
2626
cy.get('input[type=file]').selectFile('file.json')
@@ -37,7 +37,7 @@ cy.get('input[type=file]').selectFile('file.json', { action: 'drag-drop' })
3737
cy.document().selectFile('file.json', { action: 'drag-drop' })
3838
```
3939

40-
**<Icon name="exclamation-triangle" color="red" /> Incorrect Usage**
40+
<Icon name="exclamation-triangle" color="red" /> **Incorrect Usage**
4141

4242
```javascript
4343
// Errors, cannot be chained off 'cy'
@@ -50,7 +50,7 @@ cy.get('input[type=file]').selectFile('file contents')
5050

5151
### Arguments
5252

53-
**<Icon name="angle-right" /> file** **_(String, Array, Object or
53+
<Icon name="angle-right" /> **file _(String, Array, Object or
5454
Cypress.Buffer)_**
5555

5656
Either a single file, or an array of files. A file can be:
@@ -77,7 +77,7 @@ If an object is provided, it can have the following properties.
7777
| `mimeType` | The [mimeType](https://developer.mozilla.org/en-US/docs/Web/API/File/type) of the file. If omitted, it will be [inferred](https://github.com/jshttp/mime-types#mimelookuppath) from the file extension. If one cannot be inferred, it will default to an empty string. |
7878
| `lastModified` | The file's last modified timestamp, in milliseconds elapsed since the UNIX epoch (eg. [`Date.prototype.getTime()`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date/getTime)). This defaults to `Date.now()`. |
7979

80-
**<Icon name="angle-right" /> options** **_(Object)_**
80+
<Icon name="angle-right" /> **options _(Object)_**
8181

8282
Pass in an options object to change the default behavior of `.selectFile()`.
8383

docs/api/actions/trigger.mdx

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -21,13 +21,13 @@ chain further commands that rely on the subject after `.trigger()`.
2121

2222
### Usage
2323

24-
**<Icon name="check-circle" color="green" /> Correct Usage**
24+
<Icon name="check-circle" color="green" /> **Correct Usage**
2525

2626
```javascript
2727
cy.get('a').trigger('mousedown') // Trigger mousedown event on link
2828
```
2929

30-
**<Icon name="exclamation-triangle" color="red" /> Incorrect Usage**
30+
<Icon name="exclamation-triangle" color="red" /> **Incorrect Usage**
3131

3232
```javascript
3333
cy.trigger('touchstart') // Errors, cannot be chained off 'cy'
@@ -36,11 +36,11 @@ cy.clock().trigger('mouseleave') // Errors, 'clock' does not yield DOM elements
3636

3737
### Arguments
3838

39-
**<Icon name="angle-right" /> eventName** **_(String)_**
39+
<Icon name="angle-right" /> **eventName _(String)_**
4040

4141
The name of the `event` to be triggered on the DOM element.
4242

43-
**<Icon name="angle-right" /> position** **_(String)_**
43+
<Icon name="angle-right" /> **position _(String)_**
4444

4545
The position where the event should be triggered. The `center` position is the
4646
default position. Valid positions are `topLeft`, `top`, `topRight`, `left`,
@@ -51,15 +51,15 @@ default position. Valid positions are `topLeft`, `top`, `topRight`, `left`,
5151
alt="cypress-command-positions-diagram"
5252
/>
5353

54-
**<Icon name="angle-right" /> x** **_(Number)_**
54+
<Icon name="angle-right" /> **x _(Number)_**
5555

5656
The distance in pixels from element's left to trigger the event.
5757

58-
**<Icon name="angle-right" /> y** **_(Number)_**
58+
<Icon name="angle-right" /> **y _(Number)_**
5959

6060
The distance in pixels from element's top to trigger the event.
6161

62-
**<Icon name="angle-right" /> options** **_(Object)_**
62+
<Icon name="angle-right" /> **options _(Object)_**
6363

6464
Pass in an options object to change the default behavior of `.trigger()`.
6565

0 commit comments

Comments
 (0)