debian-mirror-gitlab/doc/.vale/gitlab/ReadingLevel.yml

16 lines
526 B
YAML
Raw Normal View History

2021-10-27 15:23:28 +05:30
---
# Suggestion: gitlab.ReadingLevel
#
# Checks the Flesch-Kincaid reading level.
#
2022-03-02 08:16:31 +05:30
# https://docs.errata.ai/vale/styles#metric
2023-01-13 00:05:48 +05:30
#
# For a list of all options, see https://vale.sh/docs/topics/styles/
2022-03-02 08:16:31 +05:30
extends: metric
2023-01-13 00:05:48 +05:30
message: "The grade level is %s. Aim for 8th grade or lower by using shorter sentences and words."
2021-11-11 11:23:49 +05:30
link: https://docs.gitlab.com/ee/development/documentation/testing.html#vale-readability-score
2021-10-27 15:23:28 +05:30
level: suggestion
2022-03-02 08:16:31 +05:30
formula: |
(0.39 * (words / sentences)) + (11.8 * (syllables / words)) - 15.59
condition: "> 1"