Parcourir la source

Rephrase findAttributeRange API docs,

to address https://github.com/ckeditor/ckeditor5/pull/7546#discussion_r454279790.
Tomek Wytrębowicz il y a 5 ans
Parent
commit
ea2c463b00
1 fichiers modifiés avec 3 ajouts et 2 suppressions
  1. 3 2
      packages/ckeditor5-typing/src/utils/findattributerange.js

+ 3 - 2
packages/ckeditor5-typing/src/utils/findattributerange.js

@@ -8,8 +8,9 @@
  */
 
 /**
- * Returns a range containing the entire {@link module:engine/view/attributeelement~AttributeElement#childCount attribute element}
- * in which the given `position` is placed.
+ * Returns a model range that covers all consecutive
+ * {@link module:engine/view/attributeelement~AttributeElement attribute elements}
+ * of the given `attributeName` and `value` that intersect the given `position`.
  *
  * It can be used e.g. to get the entire range on which the `linkHref` attribute needs to be changed when having a
  * selection inside a link.