浏览代码

Apply suggestions from code review

Co-authored-by: Piotrek Koszuliński <pkoszulinski@gmail.com>
Szymon Cofalik 5 年之前
父节点
当前提交
614d27da20

+ 1 - 1
docs/framework/guides/architecture/editing-engine.md

@@ -163,7 +163,7 @@ Markers are a special type of ranges.
 * They can be {@link module:engine/conversion/downcasthelpers~DowncastHelpers#markerToData converted to the data view}, to store them with the document data.
 * They can be {@link module:engine/conversion/upcasthelpers~UpcastHelpers#dataToMarker loaded with the document data}.
 
-Markers are ideal for storing and maintaining additional data &mdash; such as comments or selections of other users &mdash; that is related to some portion of the content.
+Markers are ideal for storing and maintaining additional data related to portions of the document &mdash; such as comments or selections of other users.
 
 ### Schema
 

+ 4 - 4
packages/ckeditor5-engine/src/conversion/downcasthelpers.js

@@ -239,8 +239,8 @@ export default class DowncastHelpers extends ConversionHelpers {
 	/**
 	 * Model marker to view element conversion helper.
 	 *
-	 * **Note**: This method should be used only for editing downcast. For data downcast, use {@link #markerToData} which produces
-	 * valid HTML data.
+	 * **Note**: This method should be used only for editing downcast. For data downcast, use
+	 * {@link #markerToData `#markerToData()`} that produces valid HTML data.
 	 *
 	 * This conversion results in creating a view element on the boundaries of the converted marker. If the converted marker
 	 * is collapsed, only one element is created. For example, model marker set like this: `<paragraph>F[oo b]ar</paragraph>`
@@ -366,7 +366,7 @@ export default class DowncastHelpers extends ConversionHelpers {
 	 *
 	 * * if the marker boundary is at a position where text nodes are allowed, then a view element with specified tag name
 	 * and `name` attribute is added at that position,
-	 * * in other case, a specified attribute is set on an view element that is before/after marker boundary.
+	 * * in other cases, a specified attribute is set on a view element that is before/after marker boundary.
 	 *
 	 * Tag and attribute names and values are generated from the marker name:
 	 *
@@ -375,7 +375,7 @@ export default class DowncastHelpers extends ConversionHelpers {
 	 * * templates for view elements are `<group-start name="name">` and `<group-end name="name">`.
 	 *
 	 * Attributes mark whether given marker start or end boundary is before or after given element.
-	 * Attributes `data-group-start-before` and `data-group-end-after` are favored. Other two are used when former two cannot be used.
+	 * Attributes `data-group-start-before` and `data-group-end-after` are favored. The other two are used when the former two cannot be used.
 	 *
 	 * Typically, the marker names use `group:uniqueId:otherData` convention. For example: `comment:e34zfk9k2n459df53sjl34:zx32c`.
 	 * The default configuration for this conversion is that the first part is `group` part and the rest of

+ 3 - 3
packages/ckeditor5-engine/src/conversion/upcasthelpers.js

@@ -346,10 +346,10 @@ export default class UpcastHelpers extends ConversionHelpers {
 	/**
 	 * View to model marker conversion helper.
 	 *
-	 * Converts view data created by {@link module:engine/conversion/downcasthelpers~DowncastHelpers#markerToData} back to a model marker.
+	 * Converts view data created by {@link module:engine/conversion/downcasthelpers~DowncastHelpers#markerToData `#markerToData()`} back to a model marker.
 	 *
-	 * This converter looks for specific view elements and view attributes that marks marker boundaries. See
-	 * {@link module:engine/conversion/downcasthelpers~DowncastHelpers#markerToData} to learn what view data is expected by this converter.
+	 * This converter looks for specific view elements and view attributes that mark marker boundaries. See
+	 * {@link module:engine/conversion/downcasthelpers~DowncastHelpers#markerToData `#markerToData()`} to learn what view data is expected by this converter.
 	 *
 	 * The `config.view` property is equal to the marker group name to convert.
 	 *