.vale.ini

StylesPath = .vale/styles

Vocab = General, Core, Data, KubeRay, RLlib, Train

MinAlertLevel = suggestion

Packages = Google

[*.rst]
# HACK(@bveeramani): I have no clue why we need to include `(:class:`.*`)` in addition
# to `(:.*:`.*`)`, but we get false positives if we don't. `TokenIgnores` is weird.
TokenIgnores = (:class:`.*`)|(:.*:`.*`)|(`.*`)

[*.{md,rst}]
BasedOnStyles = Vale, Google
# We're disabling "Colons" because we disagree with Google's suggestion to lowercase the
# first word after a colon.
Google.Colons = No
# TODO(@bveeramani): We're temporarily disabling "Heading". In the future, we'll update
# all headings and enable this rule.
Google.Headings = No
# "HeadingPunctuation" reads the period in a numbered heading such as
# "### 1. Label your worker nodes" as a heading-ending period, so it can't tell a
# real violation from a list-style heading. Warn instead of erroring.
Google.HeadingPunctuation = warning
# "OxfordComma" fires on "X, A and B" where A and B modify X rather than
# continuing a list, as in "resources used by all operators, active and
# requested". Warn instead of erroring.
Google.OxfordComma = warning

# ignore the anchors of headers.
BlockIgnores = (?m)(^\([\w-]+\)=$)

# Ray on Kubernetes and KubeRay terminology. See the "Writing Ray on Kubernetes and
# KubeRay docs" section of doc/source/ray-contribute/writing-style.md.
#
# This isn't enforced yet. The Vale pre-commit hook is scoped to doc/source/data/, so
# Vale never runs against these paths in CI. Registering the style and vocabulary here
# keeps the configuration ready and lets contributors run Vale on these pages by hand:
#
#   vale doc/source/cluster/kubernetes/
#
# To enforce, widen the `files` pattern on the vale hook in .pre-commit-config.yaml.
[doc/source/cluster/kubernetes/**/*.{md,rst}]
BasedOnStyles = Vale, Google, KubeRay
Google.Colons = No
Google.Headings = No