8
0
Эх сурвалжийг харах

Docs: API docs corrected.

Anna Tomanek 8 жил өмнө
parent
commit
3f16e9cd23

+ 6 - 6
packages/ckeditor5-paragraph/src/paragraph.js

@@ -18,7 +18,7 @@ import buildViewConverter from '@ckeditor/ckeditor5-engine/src/conversion/buildv
 
 /**
  * The paragraph feature for the editor.
- * Introduces the `<paragraph>` element in the model which renders as a `<p>` element in the DOM and data.
+ * It introduces the `<paragraph>` element in the model which renders as a `<p>` element in the DOM and data.
  *
  * @extends module:core/plugin~Plugin
  */
@@ -95,7 +95,7 @@ export default class Paragraph extends Plugin {
 }
 
 /**
- * List of element names which should be treated by the autoparagraphing algorithms as
+ * A list of element names which should be treated by the autoparagraphing algorithms as
  * paragraph-like. This means that e.g. the following content:
  *
  *		<h1>Foo</h1>
@@ -111,8 +111,8 @@ export default class Paragraph extends Plugin {
  *			</tr>
  *		</table>
  *
- * Contains five paragraph-like elements – `<h1>` and two `<td>` and two `<li>`.
- * Hence, if none of the features is going to convert  those elements the above content will be automatically handled
+ * contains five paragraph-like elements: `<h1>`, two `<td>`s and two `<li>`s.
+ * Hence, if none of the features is going to convert those elements the above content will be automatically handled
  * by the paragraph feature and converted to:
  *
  *		<p>Foo</p>
@@ -120,8 +120,8 @@ export default class Paragraph extends Plugin {
  *		<p>Y</p>
  *		<p>Z</p>
  *
- * Note: The `<td>` containing two `<li>` elements was ignored – the inner-most paragraph-like elements
- * have priority upon conversion.
+ * Note: The `<td>` containing two `<li>` elements was ignored as the innermost paragraph-like elements
+ * have a priority upon conversion.
  *
  * @member {Set.<String>} module:paragraph/paragraph~Paragraph.paragraphLikeElements
  */

+ 6 - 6
packages/ckeditor5-paragraph/src/paragraphcommand.js

@@ -18,7 +18,7 @@ import first from '@ckeditor/ckeditor5-utils/src/first';
  */
 export default class ParagraphCommand extends Command {
 	/**
-	 * The value of the command. Indicates whether the selection's start is placed in a paragraph.
+	 * The value of the command. Indicates whether the selection start is placed in a paragraph.
 	 *
 	 * @readonly
 	 * @observable
@@ -41,11 +41,11 @@ export default class ParagraphCommand extends Command {
 	 * will be turned to paragraphs.
 	 *
 	 * @fires execute
-	 * @param {Object} [options] Options for executed command.
-	 * @param {module:engine/model/batch~Batch} [options.batch] Batch to collect all the change steps.
-	 * New batch will be created if this option is not set.
-	 * @param {module:engine/model/selection~Selection} [options.selection] Selection the command should be applied to.
-	 * By default, if not provided, the command is applied to {@link module:engine/model/document~Document#selection}.
+	 * @param {Object} [options] Options for the executed command.
+	 * @param {module:engine/model/batch~Batch} [options.batch] A batch to collect all the change steps.
+	 * A new batch will be created if this option is not set.
+	 * @param {module:engine/model/selection~Selection} [options.selection] The selection that the command should be applied to.
+	 * By default, if not provided, the command is applied to the {@link module:engine/model/document~Document#selection}.
 	 */
 	execute( options = {} ) {
 		const document = this.editor.document;