ray/.vale.ini at master · ray-project/ray · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
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 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