Welcome to mirror list, hosted at ThFree Co, Russian Federation.

ReadingLevel.yml « gitlab « .vale « doc - gitlab.com/gitlab-org/gitlab-foss.git - Unnamed repository; edit this file 'description' to name the repository.
summaryrefslogtreecommitdiff
blob: cd7597ee8dc51cf0629b110e6729a9128905fa47 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
---
# Suggestion: gitlab.ReadingLevel
#
# Checks the Flesch-Kincaid reading level.
#
# https://docs.errata.ai/vale/styles#metric
extends: metric
message: "The grade level - %s - refers to how hard the content is to understand. Aim for 8th grade or lower by using shorter sentences and words."
link: https://docs.gitlab.com/ee/development/documentation/testing.html#vale-readability-score
level: suggestion
formula: |
  (0.39 * (words / sentences)) + (11.8 * (syllables / words)) - 15.59
condition: "> 1"