Browse Source

Docs: Lang corrections for API docs of the Notification#showWarning() method.

Marek Lewandowski 6 years ago
parent
commit
666def4d79
1 changed files with 10 additions and 9 deletions
  1. 10 9
      packages/ckeditor5-ui/src/notification/notification.js

+ 10 - 9
packages/ckeditor5-ui/src/notification/notification.js

@@ -104,29 +104,30 @@ export default class Notification extends Plugin {
 	}
 	}
 
 
 	/**
 	/**
-	 * Shows warning notification.
+	 * Shows a warning notification.
 	 *
 	 *
-	 * At default it fires `show:warning` event with given data but event namespace can be extended
-	 * by `data.namespace` option e.g.
+	 * By default it fires the {@link #show:warning `show:warning`} event with a given `data` but event namespace can be extended
+	 * using `data.namespace` option e.g.
 	 *
 	 *
 	 * 		showWarning( 'Image upload error.', {
 	 * 		showWarning( 'Image upload error.', {
 	 * 			namespace: 'upload:image'
 	 * 			namespace: 'upload:image'
 	 * 		} );
 	 * 		} );
 	 *
 	 *
 	 * will fire `show:warning:upload:image` event.
 	 * will fire `show:warning:upload:image` event.
-	 * Title of the notification can be provided:
+	 *
+	 * The title of the notification can be provided:
 	 *
 	 *
 	 *		showWarning( 'Image upload error.', {
 	 *		showWarning( 'Image upload error.', {
 	 *			title: 'Upload failed'
 	 *			title: 'Upload failed'
-	 *		});
+	 *		} );
 	 *
 	 *
-	 * Note that each unhandled and not stopped `warning` notification will be displayed as system alert.
-	 * Plugin responsible for displaying warnings should `stop()` the event to prevent of displaying it as alert:
+	 * Note that each unhandled and not stopped `warning` notification will be displayed as a system alert.
+	 * Plugin responsible for displaying warnings should `stop()` the event to prevent displaying it as an alert:
 	 *
 	 *
 	 * 		notifications.on( 'show:warning', ( evt, data ) => {
 	 * 		notifications.on( 'show:warning', ( evt, data ) => {
 	 * 			// Do something with data.
 	 * 			// Do something with data.
 	 *
 	 *
-	 * 			// Stop this event to prevent of displaying as alert.
+	 * 			// Stop this event to prevent displaying it as an alert.
 	 * 			evt.stop();
 	 * 			evt.stop();
 	 * 		} );
 	 * 		} );
 	 *
 	 *
@@ -139,7 +140,7 @@ export default class Notification extends Plugin {
 	 * 		notifications.on( 'show:warning', ( evt, data ) => {
 	 * 		notifications.on( 'show:warning', ( evt, data ) => {
 	 * 			// Log warning to some error tracker.
 	 * 			// Log warning to some error tracker.
 	 *
 	 *
-	 * 			// Stop this event to prevent of displaying as alert.
+	 * 			// Stop this event to prevent displaying it as an alert.
 	 * 			evt.stop();
 	 * 			evt.stop();
 	 * 		}, { priority: 'low' } );
 	 * 		}, { priority: 'low' } );
 	 *
 	 *