docs(python): add Error base class (#6315)

This commit is contained in:
Max Schmitt 2021-04-28 10:41:46 +02:00 committed by GitHub
parent 0039b313b8
commit 1b771ed360
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
2 changed files with 27 additions and 1 deletions

View file

@ -0,0 +1,26 @@
# class: Error
* langs: python
* extends: [Exception]
Error is raised whenever certain operations are terminated abnormally, e.g.
browser closes while [`method: Page.evaluate`] is running. All Playwright exceptions
inherit from this class.
- [error.message](./api/class-error.mdx#errormessage)
- [error.name](./api/class-error.mdx#errorname)
- [error.stack](./api/class-error.mdx#errorstack)
## property: Error.message
- returns: <[str]>
Message of the error.
## property: Error.name
- returns: <[str]>
Name of the error which got thrown inside the browser. Optional.
## property: Error.stack
- returns: <[str]>
Stack of the error which got thrown inside the browser. Optional.

View file

@ -68,7 +68,7 @@ class Documentation {
for (const [name, clazz] of this.classes.entries()) {
clazz.validateOrder(errors, clazz);
if (!clazz.extends || clazz.extends === 'EventEmitter' || clazz.extends === 'Error' || clazz.extends === 'RuntimeException')
if (!clazz.extends || ['EventEmitter', 'Error', 'Exception', 'RuntimeException'].includes(clazz.extends))
continue;
const superClass = this.classes.get(clazz.extends);
if (!superClass) {