Skip to content

Commit

Permalink
Fix caution and warning admonitions (#1682)
Browse files Browse the repository at this point in the history
  • Loading branch information
heitortsergent authored Aug 2, 2024
1 parent 9eb02ec commit 4110f5d
Show file tree
Hide file tree
Showing 600 changed files with 651 additions and 651 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -122,7 +122,7 @@ Flags:

{{< /code >}}

{{% admonition type="caution" %}}
{{< admonition type="caution" >}}

The use of `--replace` should be considered an advanced feature to be avoided unless required.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -176,7 +176,7 @@ to access the [`modules.VU`](https://pkg.go.dev/go.k6.io/k6/js/modules#VU) to in
Additionally, there should be a root module implementation of the [`modules.Module`](https://pkg.go.dev/go.k6.io/k6/js/modules#Module)
interface to serve as a factory of `Compare` instances for each VU.

{{% admonition type="caution" %}}
{{< admonition type="caution" >}}

The significance depends on the size of your module.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ There should be a reasonably high degree of quality and stability at this point.
This phase makes the feature accessible to more users, which in turn gives k6 developers more chances to receive feedback.
The key will be to achieve a balance between usability and stability.

{{% admonition type="caution" %}}
{{< admonition type="caution" >}}

Not all experimental modules will progress to become a core module!
The k6 team reserves the right to discontinue and remove any experimental module if is no longer deemed desirable.
Expand Down
2 changes: 1 addition & 1 deletion docs/sources/next/javascript-api/jslib/httpx/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ httpx module integrates well with the expect library.
The source code is [on GitHub](https://github.com/k6io/k6-jslib-httpx).
Please request features and report bugs through [GitHub issues](https://github.com/k6io/k6-jslib-httpx/issues).

{{% admonition type="caution" %}}
{{< admonition type="caution" >}}

**This library is in active development.**

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ description: 'Returns a list of pages inside this BrowserContext.'

# pages()

{{% admonition type="caution" %}}
{{< admonition type="caution" >}}

This feature has **known issues**. For details, refer to
[#444](https://github.com/grafana/xk6-browser/issues/444).
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ description: "Sets the BrowserContext's geolocation."

# setGeolocation(geolocation)

{{% admonition type="caution" %}}
{{< admonition type="caution" >}}

This feature has **known issues**. For details, refer to
[#435](https://github.com/grafana/xk6-browser/issues/435).
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ description: 'Browser module: elementHandle.check method'

# check([options])

{{% admonition type="warning" %}}
{{< admonition type="warning" >}}

Use [`locator.check([options])`](https://grafana.com/docs/k6/<K6_VERSION>/javascript-api/k6-browser/locator/check/) instead.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ description: 'Browser module: elementHandle.click method'

# click([options])

{{% admonition type="warning" %}}
{{< admonition type="warning" >}}

Use [`locator.click([options])`](https://grafana.com/docs/k6/<K6_VERSION>/javascript-api/k6-browser/locator/click/) instead.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ description: 'Browser module: elementHandle.dblclick method'

# dblclick([options])

{{% admonition type="warning" %}}
{{< admonition type="warning" >}}

Use [`locator.dblclick([options])`](https://grafana.com/docs/k6/<K6_VERSION>/javascript-api/k6-browser/locator/dblclick/) instead.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ description: 'Browser module: elementHandle.dispatchEvent method'

# dispatchEvent(type, eventInit)

{{% admonition type="warning" %}}
{{< admonition type="warning" >}}

Use [`locator.dispatchEvent(type, eventInit[, options])`](https://grafana.com/docs/k6/<K6_VERSION>/javascript-api/k6-browser/locator/dispatchevent/) instead.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ description: 'Browser module: elementHandle.fill method'

# fill(value, [options])

{{% admonition type="warning" %}}
{{< admonition type="warning" >}}

Use [`locator.fill(value, [options])`](https://grafana.com/docs/k6/<K6_VERSION>/javascript-api/k6-browser/locator/fill/) instead.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ description: 'Browser module: elementHandle.focus method'

# focus()

{{% admonition type="warning" %}}
{{< admonition type="warning" >}}

Use [`locator.focus([options])`](https://grafana.com/docs/k6/<K6_VERSION>/javascript-api/k6-browser/locator/focus/) instead.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ description: 'Browser module: elementHandle.getAttribute method'

# getAttribute(name)

{{% admonition type="warning" %}}
{{< admonition type="warning" >}}

Use [`locator.getAttribute(name[, options])`](https://grafana.com/docs/k6/<K6_VERSION>/javascript-api/k6-browser/locator/getattribute/) instead.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ description: 'Browser module: elementHandle.hover method'

# hover([options])

{{% admonition type="warning" %}}
{{< admonition type="warning" >}}

Use [`locator.hover([options])`](https://grafana.com/docs/k6/<K6_VERSION>/javascript-api/k6-browser/locator/hover/) instead.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ description: 'Browser module: elementHandle.innerHTML method'

# innerHTML()

{{% admonition type="warning" %}}
{{< admonition type="warning" >}}

Use [`locator.innerHTML([options])`](https://grafana.com/docs/k6/<K6_VERSION>/javascript-api/k6-browser/locator/innerhtml/) instead.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ description: 'Browser module: elementHandle.innerText method'

# innerText()

{{% admonition type="warning" %}}
{{< admonition type="warning" >}}

Use [`locator.innerText([options])`](https://grafana.com/docs/k6/<K6_VERSION>/javascript-api/k6-browser/locator/innertext/) instead.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ description: 'Browser module: elementHandle.isChecked method'

# isChecked()

{{% admonition type="warning" %}}
{{< admonition type="warning" >}}

Use [`locator.isChecked([options])`](https://grafana.com/docs/k6/<K6_VERSION>/javascript-api/k6-browser/locator/ischecked/) instead.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ description: 'Browser module: elementHandle.isDisabled method'

# isDisabled()

{{% admonition type="warning" %}}
{{< admonition type="warning" >}}

Use [`locator.isDisabled([options])`](https://grafana.com/docs/k6/<K6_VERSION>/javascript-api/k6-browser/locator/isdisabled/) instead.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ description: 'Browser module: elementHandle.isEditable method'

# isEditable()

{{% admonition type="warning" %}}
{{< admonition type="warning" >}}

Use [`locator.isEditable([options])`](https://grafana.com/docs/k6/<K6_VERSION>/javascript-api/k6-browser/locator/iseditable/) instead.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ description: 'Browser module: elementHandle.isEnabled method'

# isEnabled()

{{% admonition type="warning" %}}
{{< admonition type="warning" >}}

Use [`locator.isEnabled([options])`](https://grafana.com/docs/k6/<K6_VERSION>/javascript-api/k6-browser/locator/isenabled/) instead.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ description: 'Browser module: elementHandle.isHidden method'

# isHidden()

{{% admonition type="warning" %}}
{{< admonition type="warning" >}}

Use [`locator.isHidden()`](https://grafana.com/docs/k6/<K6_VERSION>/javascript-api/k6-browser/locator/ishidden/) instead.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ description: 'Browser module: elementHandle.isVisible method'

# isVisible()

{{% admonition type="warning" %}}
{{< admonition type="warning" >}}

Use [`locator.isVisible()`](https://grafana.com/docs/k6/<K6_VERSION>/javascript-api/k6-browser/locator/isvisible/) instead.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ description: 'Browser module: elementHandle.press method'

# press(key, [options])

{{% admonition type="warning" %}}
{{< admonition type="warning" >}}

Use [`locator.press(key[, options])`](https://grafana.com/docs/k6/<K6_VERSION>/javascript-api/k6-browser/locator/press/) instead.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ description: 'Browser module: elementHandle.$ method'

# $(selector)

{{% admonition type="warning" %}}
{{< admonition type="warning" >}}

Use [`page.locator(selector[, options])`](https://grafana.com/docs/k6/<K6_VERSION>/javascript-api/k6-browser/locator/) instead.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ description: 'Browser module: elementHandle.selectOption method'

# selectOption(values, [options])

{{% admonition type="warning" %}}
{{< admonition type="warning" >}}

Use [`locator.selectOption(values[, options])`](https://grafana.com/docs/k6/<K6_VERSION>/javascript-api/k6-browser/locator/selectoption/) instead.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ description: 'Browser module: elementhandle.tap method'

# tap(options)

{{% admonition type="warning" %}}
{{< admonition type="warning" >}}

Use [`locator.tap([options])`](https://grafana.com/docs/k6/<K6_VERSION>/javascript-api/k6-browser/locator/tap/) instead.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ description: 'Browser module: elementHandle.textContent method'

# textContent()

{{% admonition type="warning" %}}
{{< admonition type="warning" >}}

Use [`locator.textContent([options])`](https://grafana.com/docs/k6/<K6_VERSION>/javascript-api/k6-browser/locator/textcontent/) instead.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ description: 'Browser module: elementHandle.type method'

# type(text, [options])

{{% admonition type="warning" %}}
{{< admonition type="warning" >}}

Use [`locator.type([options])`](https://grafana.com/docs/k6/<K6_VERSION>/javascript-api/k6-browser/locator/type/) instead.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ description: 'Browser module: elementHandle.uncheck method'

# uncheck([options])

{{% admonition type="warning" %}}
{{< admonition type="warning" >}}

Use [`locator.uncheck([options])`](https://grafana.com/docs/k6/<K6_VERSION>/javascript-api/k6-browser/locator/uncheck/) instead.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ description: 'Browser module: elementHandle.waitForSelector method'

# waitForSelector(selector[, options])

{{% admonition type="warning" %}}
{{< admonition type="warning" >}}

Use [`locator.waitFor([options])`](https://grafana.com/docs/k6/<K6_VERSION>/javascript-api/k6-browser/locator/waitfor/) instead.

Expand Down
2 changes: 1 addition & 1 deletion docs/sources/next/javascript-api/k6-browser/frame/check.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ description: 'Browser module: frame.check(selector[, options]) method'

# check(selector[, options])

{{% admonition type="warning" %}}
{{< admonition type="warning" >}}

Use locator-based [`locator.check([options])`](https://grafana.com/docs/k6/<K6_VERSION>/javascript-api/k6-browser/locator/check/) instead.

Expand Down
2 changes: 1 addition & 1 deletion docs/sources/next/javascript-api/k6-browser/frame/click.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ description: 'Browser module: frame.click(selector[, options]) method'

# click(selector[, options])

{{% admonition type="warning" %}}
{{< admonition type="warning" >}}

Use locator-based [`locator.click([options])`](https://grafana.com/docs/k6/<K6_VERSION>/javascript-api/k6-browser/locator/click/) instead.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ description: 'Browser module: frame.dblclick(selector[, options]) method'

# dblclick(selector[, options])

{{% admonition type="warning" %}}
{{< admonition type="warning" >}}

Use locator-based [`locator.dblclick([options])`](https://grafana.com/docs/k6/<K6_VERSION>/javascript-api/k6-browser/locator/dblclick/) instead.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ description: 'Browser module: frame.dispatchEvent(selector, type, eventInit[, op

# dispatchEvent(selector, type, eventInit[, options])

{{% admonition type="warning" %}}
{{< admonition type="warning" >}}

Use locator-based [`locator.dispatchEvent(type, eventInit[, options])`](https://grafana.com/docs/k6/<K6_VERSION>/javascript-api/k6-browser/locator/dispatchevent/) instead.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ description: 'Browser module: frame.$(selector) method'

# $(selector)

{{% admonition type="warning" %}}
{{< admonition type="warning" >}}

Use locator-based [`frame.locator(selector)`](https://grafana.com/docs/k6/<K6_VERSION>/javascript-api/k6-browser/frame/locator/) instead.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ description: 'Browser module: frame.$$(selector) method'

# $$(selector)

{{% admonition type="warning" %}}
{{< admonition type="warning" >}}

Use locator-based [`frame.locator(selector)`](https://grafana.com/docs/k6/<K6_VERSION>/javascript-api/k6-browser/frame/locator/) instead.

Expand Down
2 changes: 1 addition & 1 deletion docs/sources/next/javascript-api/k6-browser/frame/fill.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ description: 'Browser module: frame.fill(selector, value[, options]) method'

# fill(selector, value[, options])

{{% admonition type="warning" %}}
{{< admonition type="warning" >}}

Use locator-based [`locator.fill(value[, options])`](https://grafana.com/docs/k6/<K6_VERSION>/javascript-api/k6-browser/locator/fill/) instead.

Expand Down
2 changes: 1 addition & 1 deletion docs/sources/next/javascript-api/k6-browser/frame/focus.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ description: 'Browser module: frame.focus(selector[, options]) method'

# focus(selector[, options])

{{% admonition type="warning" %}}
{{< admonition type="warning" >}}

Use locator-based [`locator.focus([options])`](https://grafana.com/docs/k6/<K6_VERSION>/javascript-api/k6-browser/locator/focus/) instead.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ description: 'Browser module: frame.getAttribute(selector, name[, options]) meth

# getAttribute(selector, name[, options])

{{% admonition type="warning" %}}
{{< admonition type="warning" >}}

Use locator-based [`locator.getAttribute()`](https://grafana.com/docs/k6/<K6_VERSION>/javascript-api/k6-browser/locator/getattribute/) instead.

Expand Down
2 changes: 1 addition & 1 deletion docs/sources/next/javascript-api/k6-browser/frame/goto.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ Navigating to `about:blank` or navigation to the same URL with a different hash,

### Events

{{% admonition type="caution" %}}
{{< admonition type="caution" >}}

`networkidle` is DISCOURAGED. Don't use this method for testing especially with chatty websites where the event may never fire, rely on web assertions to assess readiness instead.

Expand Down
2 changes: 1 addition & 1 deletion docs/sources/next/javascript-api/k6-browser/frame/hover.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ description: 'Browser module: frame.hover(selector[, options]) method'

# hover(selector[, options])

{{% admonition type="warning" %}}
{{< admonition type="warning" >}}

Use locator-based [`locator.hover([options])`](https://grafana.com/docs/k6/<K6_VERSION>/javascript-api/k6-browser/locator/hover/) instead.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ description: 'Browser module: frame.innerHTML(selector[, options]) method'

# innerHTML(selector[, options])

{{% admonition type="warning" %}}
{{< admonition type="warning" >}}

Use locator-based [`locator.innerHTML([options])`](https://grafana.com/docs/k6/<K6_VERSION>/javascript-api/k6-browser/locator/innerhtml/) instead.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ description: 'Browser module: frame.innerText(selector[, options]) method'

# innerText(selector[, options])

{{% admonition type="warning" %}}
{{< admonition type="warning" >}}

Use locator-based [`locator.innerText([options])`](https://grafana.com/docs/k6/<K6_VERSION>/javascript-api/k6-browser/locator/innertext/) instead.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ description: 'Browser module: frame.inputValue(selector[, options]) method'

# inputValue(selector[, options])

{{% admonition type="warning" %}}
{{< admonition type="warning" >}}

Use locator-based [`locator.inputValue([options])`](https://grafana.com/docs/k6/<K6_VERSION>/javascript-api/k6-browser/locator/inputvalue/) instead.

Expand Down
Loading

0 comments on commit 4110f5d

Please sign in to comment.