GeezerVison is showing github.com — ray/.vale.ini at master · ray-project/ray

Expand file tree

.vale.ini

Copy path

More file actions

Latest commit

History

129 lines (117 loc) · 5.05 KB

.vale.ini

Copy path

File metadata and controls

129 lines (117 loc) · 5.05 KB

Raw

Copy raw file

Download raw file

Open symbols panel

Edit and raw actions

100

101

102

103

104

105

106

107

108

109

110

111

112

113

114

115

116

117

118

119

120

121

122

123

124

125

126

127

128

129

StylesPath = .vale/styles

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

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 commented out, and both its

# `files` pattern and the top-level `exclude` admit only 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/kuberay/ doc/source/cluster/kubernetes.md

# To enforce, uncomment the Vale hook in .pre-commit-config.yaml, then widen its `files`

# pattern and the doc/source/ carve-out in the top-level `exclude`.

[doc/source/kuberay/**/*.{md,rst}]

BasedOnStyles = Vale, Google, KubeRay

Google.Colons = No

Google.Headings = No

[doc/source/cluster/kubernetes.md]

BasedOnStyles = Vale, Google, KubeRay

Google.Colons = No

Google.Headings = No

# RLlib style pass. Adds the shared Ray plain-word rules and the RLlib terminology

# library. See the "Word choice" and related sections of

# doc/source/ray-contribute/writing-style.md, plus .vale/styles/Ray/ and

# .vale/styles/RLlib/Terms.yml.

# Not enforced yet, same as the KubeRay block above: Vale never runs these in CI.

# Registering the styles here keeps them ready and lets contributors run Vale on RLlib

# pages by hand during the style pass:

# vale doc/source/rllib/

# The shared Ray style is scoped to RLlib for now; move it to the global [*.{md,rst}]

# section once other libraries adopt it. To enforce, follow the steps in the KubeRay

# block above.

[doc/source/rllib/**/*.{md,rst}]

BasedOnStyles = Vale, Google, Ray, RLlib

Google.Colons = No

Google.Headings = No

Google.HeadingPunctuation = warning

Google.OxfordComma = warning

# Ray Core style pass. Adds the shared Ray plain-word rules and the Ray Core terminology

# library. See the "Writing Ray Core docs" section of

# doc/source/ray-contribute/writing-style.md, plus .vale/styles/Core/.

# Not enforced yet, same as the KubeRay and RLlib blocks above: Vale never runs these in

# CI. Registering the styles here keeps them ready and lets contributors run Vale on Ray

# Core pages by hand during the style pass:

# vale doc/source/core/

# To enforce, follow the steps in the KubeRay block above.

[doc/source/core/**/*.{md,rst}]

BasedOnStyles = Vale, Google, Ray, Core

Google.Colons = No

Google.Headings = No

Google.HeadingPunctuation = warning

Google.OxfordComma = warning

# Ray Train style pass. Adds the shared Ray plain-word rules and the Ray Train

# terminology library. See the "Writing Ray Train docs" section of

# doc/source/ray-contribute/writing-style.md, plus .vale/styles/Train/.

# Not enforced yet, same as the KubeRay, RLlib, and Ray Core blocks above: Vale never

# runs these in CI. Registering the styles here keeps them ready and lets contributors

# run Vale on Ray Train pages by hand during the style pass:

# vale doc/source/train/

# To enforce, follow the steps in the KubeRay block above.

[doc/source/train/**/*.{md,rst}]

BasedOnStyles = Vale, Google, Ray, Train

Google.Colons = No

Google.Headings = No

Google.HeadingPunctuation = warning

Google.OxfordComma = warning

# Ray Tune style pass. Adds the shared Ray plain-word rules and the Ray Tune

# terminology library. See the "Writing Ray Tune docs" section of

# doc/source/ray-contribute/writing-style.md, plus .vale/styles/Tune/.

# Not enforced yet, same as the KubeRay, RLlib, Ray Core, and Ray Train blocks above:

# Vale never runs these in CI. Registering the styles here keeps them ready and lets

# contributors run Vale on Ray Tune pages by hand during the style pass:

# vale doc/source/tune/

# To enforce, follow the steps in the KubeRay block above.

[doc/source/tune/**/*.{md,rst}]

BasedOnStyles = Vale, Google, Ray, Tune

Google.Colons = No

Google.Headings = No

Google.HeadingPunctuation = warning

Google.OxfordComma = warning