doc: update documentation

see issue#92 [skip travis-ci]
mnater · Mar 11, 2020 · 57988ab · 57988ab
1 parent 9d75517
commit 57988ab
Showing 1 changed file with 3 additions and 1 deletion.
diff --git a/docs/Hyphenators.md b/docs/Hyphenators.md
@@ -70,7 +70,9 @@ In the example above we enforced Hyphenopoly_Loader.js to use Hyphenopoly.js for
 In the example a `string` is handed over to the `hyphenator` which returns a hyphenated string according to the settings for the `selector`. If no `selector` is defined it defaults to `".hyphenate"`.
 
 ## Use `Hyphenopoly.hyphenators` for DOM-Elements
-When handing over a `HTMLELEMENT` instead of a string, `hyphenators` directly hyphenate the contents of a HTMLElement and return nothing (`undefined`).
+When handing over a `HTMLELEMENT` instead of a string, `hyphenators` directly hyphenate the text contents of a HTMLElement and return nothing (`undefined`).
+
+**Please Note:** Hyphenators only hyphenate the _text content_ of an element and DO NOT hyphenate any childElements.
 
 ````html
 <html>