Update documentation

ehmicky · ehmicky · commit 44bea887b0e2 · 2022-10-30T19:18:20.000+01:00
diff --git a/types/main.d.ts b/types/main.d.ts
@@ -3,15 +3,15 @@ import type { Info } from 'modern-errors'
 /**
  * `modern-errors-bugs` plugin.
  *
- * The `bugs` option appends a bug reports URL to error messages.
+ * This appends a bug reports URL to error messages.
  *
  * @example
  * ```js
  * export const UnknownError = AnyError.subclass('UnknownError', {
  *   bugs: 'https://github.com/my-name/my-project/issues',
  * })
  *
- * // UnknownError: Cannot read properties of null (reading 'trim')
+ * // Errors now include the following message:
  * // Please report this bug at: https://github.com/my-name/my-project/issues
  * ```
  */

Original file line number	Diff line number	Diff line change
`@@ -3,15 +3,15 @@ import type { Info } from 'modern-errors'`
`3`	`3`	`/**`
`4`	`4`	* `modern-errors-bugs` plugin.
`5`	`5`	`*`
`6`		- * The `bugs` option appends a bug reports URL to error messages.
	`6`	`+ * This appends a bug reports URL to error messages.`
`7`	`7`	`*`
`8`	`8`	`* @example`
`9`	`9`	* ```js
`10`	`10`	`* export const UnknownError = AnyError.subclass('UnknownError', {`
`11`	`11`	`* bugs: 'https://github.com/my-name/my-project/issues',`
`12`	`12`	`* })`
`13`	`13`	`*`
`14`		`- * // UnknownError: Cannot read properties of null (reading 'trim')`
	`14`	`+ * // Errors now include the following message:`
`15`	`15`	`* // Please report this bug at: https://github.com/my-name/my-project/issues`
`16`	`16`	* ```
`17`	`17`	`*/`