docs(*, new=0, autoraise=True)

Opens the pwfdf-api docs in a web browser

Open Docs

docs()

Opens the pwfdf-api docs in a web browser. Returns a boolean indicating whether the page was successfully opened.

Browser Options

docs(..., *, new)
docs(..., *, autoraise=False)

Web browser options. The new input controls how the page is opened. 0 opens in the current window, 1 opens a new window, and 2 opens a new tab. Set autoraise=False to disable raising the opened page when possible.

Note

Many web browsers ignore both these options.

Inputs:

• new (0 | 1 | 2) – (0 - default) current window, (1) new window, (2) new tab

• autoraise (bool) – True (default) to autoraise the page. False to not autoraise

Outputs:

bool – True if the page was opened successfully. Otherwise False.