@@ -234,15 +234,8 @@ As a general guideline, the lower the score, the more readable the documentation
...
@@ -234,15 +234,8 @@ As a general guideline, the lower the score, the more readable the documentation
For example, a page that scores `12` before a set of changes, and `9` after, indicates an iterative improvement to readability. The score is not an exact science, but is meant to help indicate the
For example, a page that scores `12` before a set of changes, and `9` after, indicates an iterative improvement to readability. The score is not an exact science, but is meant to help indicate the
general complexity level of the page.
general complexity level of the page.
The readability score is calculated by using the following formula:
The readability score is calculated based on the number of words per sentence, and the number
of syllables per word. For more information, see [the Vale documentation](https://docs.errata.ai/vale/styles#metric).
```plaintext
(.39 x ASL) + (11.8 x ASW) – 15.59
```
-`ASL` is average sentence length (the number of words divided by the number of sentences).
-`ASW` is the average number of syllables per word (the number of syllables divided by the number of words).
- The score excludes headings, code blocks, and lists.