Ver código fonte

API docs improvements.

Maciej Bukowski 5 anos atrás
pai
commit
9d516aa26e

+ 2 - 2
packages/ckeditor5-watchdog/docs/features/watchdog.md

@@ -133,7 +133,7 @@ watchdog.crashes.forEach( crashInfo => console.log( crashInfo ) );
 ### Context watchdog
 
 <info-box>
-	Note: the ContextWatchdog can be used only with an {@link builds/guides/integration/advanced-setup#scenario-2-building-from-source editor built from source}.
+	Note: the context watchdog can be used only with an {@link builds/guides/integration/advanced-setup#scenario-2-building-from-source editor built from source}.
 </info-box>
 
 Install the [`@ckeditor/ckeditor5-watchdog`](https://www.npmjs.com/package/@ckeditor/ckeditor5-watchdog) package:
@@ -205,7 +205,7 @@ await watchdog.remove( 'editor2' );
 
 #### Context watchdog API
 
-The ContextWatchdog feature provides the following API:
+The context watchdog feature provides the following API:
 
 ```js
 // Create watchdog that will use the `Context` class and given configuration.

+ 2 - 2
packages/ckeditor5-watchdog/src/contextwatchdog.js

@@ -105,8 +105,8 @@ export default class ContextWatchdog extends Watchdog {
 	}
 
 	/**
-	 * The context instance. Keep in mind that this property might be changed when the ContextWatchdog restarts,
-	 * so do not keep this instance internally. Always operate on the `contextWatchdog.context` property.
+	 * The context instance. Keep in mind that this property might be changed when the `ContextWatchdog` restarts,
+	 * so do not keep this instance internally. Always operate on the `ContextWatchdog#context` property.
 	 *
 	 * @type {module:core/context~Context|null}
 	 */

+ 1 - 1
packages/ckeditor5-watchdog/tests/contextwatchdog.js

@@ -299,7 +299,7 @@ describe( 'ContextWatchdog', () => {
 			expect( err.message ).to.match( /Not supported item type: 'foo'\./ );
 		} );
 
-		it( 'should allow adding and removing items without waiting', async () => {
+		it( 'should allow adding and removing items without waiting for promises', async () => {
 			watchdog = new ContextWatchdog( Context );
 
 			watchdog.create();