Snippet docs don't match behaviour

[jazoom]

Description
From the docs:

It is possible to change the size of the snippeting by adding its character size in the attributesToSnippet parameter.
For example: "description:40".

The 40 value represents the number of characters (rounded down to always have full words) and not the number of words. Thus, the snippet string size is always equal to or lower than 40 characters.

But this seems to be incorrect. For me this is showing 40 words, not a max of 40 characters.

Expected behavior
What the docs suggest.

Current behavior
Exactly the opposite of what the docs suggest.

Environment (please complete the following information):
latest of each library

[oluademola]

Hello @jazoom

The documentation is inconsistent. You are correct, and that is the expected behavior. The size indeed indicates the number of words, and It behaves exactly like the attribute to crop.

Thank you for bringing this to our notice, and we are sorry for the inconvenience.

[bidoubiwa]

The readme should be updated with the current behavior. Feel free to make a PR to fix it! No problem if you prefer not :)