From 57988abf65144580b8f8357d4af06d11e8f926d1 Mon Sep 17 00:00:00 2001 From: mnater Date: Wed, 11 Mar 2020 17:30:14 +0100 Subject: [PATCH] doc: update documentation see issue#92 [skip travis-ci] --- docs/Hyphenators.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/docs/Hyphenators.md b/docs/Hyphenators.md index 1ee1fe07..428fe333 100644 --- 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