Open topic with navigation

# has_sensible_word_lengths

The `has_sensible_word_lengths` function checks the average length of words in a document.

## Syntax

    has_sensible_word_lengths( doc
       [, minimumThreshold
       [, maximumThreshold
       [, checkedSegmentLength]]] )

## Arguments

Argument | Description
--- | ---
`doc` | (LuaDocument) The document that you want to check.
`minimumThreshold` | (float) The minimum average word length for the function to return `true`. The default is 3 characters.
`maximumThreshold` | (float) The maximum average word length for the function to return `true`. The default is 9 characters.
`checkedSegmentLength` | (integer) The number of characters in the document content that you want to check. By default, the function checks the average word length of the first 1000 characters.

## Returns

Boolean. Returns the result of the check.

## Example

    function handler(document)
       local is_sensible = has_sensible_word_lengths(
          document, 4.0, 7.0)

       if(!is_sensible)
          write_idx(document, "bad_word_length_documents.idx")
       return is_sensible
    end

© 2016 Hewlett Packard Enterprise Development LP | Send documentation feedback to HPE Close We welcome your comments! To open the configured email client on this computer, open an email window. Otherwise, copy the information below to a web mail client, and send this email to AutonomyTPFeedback@hpe.com. Product: Topic Title: Help Topic: Feedback:

_HP_HTML5_bannerTitle.htm