Skip to content

Commit 8927dff

Browse files
authored
chore: minor grammar fixes to docs (#805)
From https://github.com/aspect-build/docs/pull/171
1 parent 0fdb2e8 commit 8927dff

14 files changed

Lines changed: 21 additions & 21 deletions

lint/bandit.bzl

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
33
Typical usage:
44
5-
First, fetch `bandit[sarif]` package via your standard requirements file and pip calls.
5+
First, fetch `bandit[sarif]` package via your standard requirements file and python rules (pip, uv, etc).
66
77
Note that the `sarif` extra is **required** for machine output and the `toml` extra
88
is recommended to enable `pyproject.toml` support, see examples.
@@ -136,7 +136,7 @@ def lint_bandit_aspect(
136136
"""A factory function to create a linter aspect.
137137
138138
Args:
139-
binary: a bandit executable. Can be obtained from pypi like so:
139+
binary: a bandit executable. Obtain from pypi like so:
140140
141141
load("@rules_python//python/entry_points:py_console_script_binary.bzl", "py_console_script_binary")
142142

lint/buf.bzl

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -104,7 +104,7 @@ def lint_buf_aspect(config, toolchain = "@rules_buf//tools/protoc-gen-buf-lint:t
104104
"""A factory function to create a linter aspect.
105105
106106
Args:
107-
config: label of the the buf.yaml file
107+
config: label of the buf.yaml file
108108
toolchain: override the default toolchain of the protoc-gen-buf-lint tool
109109
rule_kinds: which [kinds](https://bazel.build/query/language#kind) of rules should be visited by the aspect
110110
"""

lint/checkstyle.bzl

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@ def checkstyle_action(ctx, executable, srcs, config, data, stdout, exit_code = N
3838
3939
Args:
4040
ctx: Bazel Rule or Aspect evaluation context
41-
executable: label of the the Checkstyle program
41+
executable: label of the Checkstyle program
4242
srcs: java files to be linted
4343
config: label of the checkstyle.xml file
4444
data: labels of additional xml files such as suppressions.xml
@@ -112,7 +112,7 @@ def lint_checkstyle_aspect(binary, config, data = [], rule_kinds = ["java_binary
112112
"""A factory function to create a linter aspect.
113113
114114
Attrs:
115-
binary: a Checkstyle executable. Can be obtained from rules_java like so:
115+
binary: a Checkstyle executable. Obtain from rules_java like so:
116116
117117
java_binary(
118118
name = "checkstyle",

lint/flake8.bzl

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
33
Typical usage:
44
5-
First, fetch the flake8 package via your standard requirements file and pip calls.
5+
First, fetch the flake8 package via your standard requirements file and python rules (pip, uv, etc).
66
77
Then, declare a binary target for it, typically in `tools/lint/BUILD.bazel`:
88
@@ -37,7 +37,7 @@ def flake8_action(ctx, executable, srcs, config, stdout, exit_code = None, optio
3737
3838
Args:
3939
ctx: Bazel Rule or Aspect evaluation context
40-
executable: label of the the flake8 program
40+
executable: label of the flake8 program
4141
srcs: python files to be linted
4242
config: label of the flake8 config file (setup.cfg, tox.ini, or .flake8)
4343
stdout: output file containing stdout of flake8
@@ -97,7 +97,7 @@ def lint_flake8_aspect(binary, config, rule_kinds = ["py_binary", "py_library"])
9797
"""A factory function to create a linter aspect.
9898
9999
Attrs:
100-
binary: a flake8 executable. Can be obtained from rules_python like so:
100+
binary: a flake8 executable. Obtain from rules_python like so:
101101
102102
load("@rules_python//python/entry_points:py_console_script_binary.bzl", "py_console_script_binary")
103103

lint/keep_sorted.bzl

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@ def keep_sorted_action(ctx, executable, srcs, stdout, exit_code = None, options
3838
3939
Args:
4040
ctx: Bazel Rule or Aspect evaluation context
41-
executable: label of the the keep-sorted program
41+
executable: label of the keep-sorted program
4242
srcs: files to be linted
4343
stdout: output file containing stdout
4444
exit_code: output file containing exit code

lint/pmd.bzl

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@ def pmd_action(ctx, executable, srcs, rulesets, stdout, exit_code = None, option
3838
3939
Args:
4040
ctx: Bazel Rule or Aspect evaluation context
41-
executable: label of the the PMD program
41+
executable: label of the PMD program
4242
srcs: java files to be linted
4343
rulesets: list of labels of the PMD ruleset files
4444
stdout: output file to generate
@@ -108,7 +108,7 @@ def lint_pmd_aspect(binary, rulesets, rule_kinds = ["java_binary", "java_library
108108
"""A factory function to create a linter aspect.
109109
110110
Attrs:
111-
binary: a PMD executable. Can be obtained from rules_java like so:
111+
binary: a PMD executable. Obtain from rules_java like so:
112112
113113
java_binary(
114114
name = "pmd",

lint/pylint.bzl

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
33
Typical usage:
44
5-
First, fetch the pylint package via your standard requirements file and pip calls.
5+
First, fetch the pylint package via your standard requirements file and python rules (pip, uv, etc).
66
77
Then, declare a binary target for it, typically in `tools/lint/BUILD.bazel`:
88
@@ -104,7 +104,7 @@ def lint_pylint_aspect(binary, config, rule_kinds = ["py_binary", "py_library",
104104
"""A factory function to create a linter aspect.
105105
106106
Args:
107-
binary: a pylint executable. Can be obtained from rules_python like so:
107+
binary: a pylint executable. Obtain from rules_python like so:
108108
109109
load("@rules_python//python/entry_points:py_console_script_binary.bzl", "py_console_script_binary")
110110

lint/rubocop.bzl

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -124,7 +124,7 @@ def rubocop_action(
124124
This means that a change to any config file invalidates the action cache
125125
entries for ALL RuboCop actions.
126126
127-
However this is needed because RuboCop's logic for selecting the
127+
However, this is important because RuboCop's logic for selecting the
128128
appropriate config needs to traverse the directory hierarchy.
129129
130130
Args:

lint/ruff.bzl

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -60,14 +60,14 @@ def ruff_action(ctx, executable, srcs, config, stdout, exit_code = None, env = {
6060
This means that a change to any config file invalidates the action cache entries for ALL
6161
ruff actions.
6262
63-
However this is needed because:
63+
However, this is important because:
6464
6565
1. ruff has an `extend` field, so it may need to read more than one config file
6666
2. ruff's logic for selecting the appropriate config needs to read the file content to detect a `[tool.ruff]` section.
6767
6868
Args:
6969
ctx: Bazel Rule or Aspect evaluation context
70-
executable: label of the the ruff program
70+
executable: label of the ruff program
7171
srcs: python files to be linted
7272
config: labels of ruff config files (pyproject.toml, ruff.toml, or .ruff.toml)
7373
stdout: output file of linter results to generate

lint/shellcheck.bzl

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ def shellcheck_action(ctx, executable, srcs, config, stdout, exit_code = None, o
2626
2727
Args:
2828
ctx: Bazel Rule or Aspect evaluation context
29-
executable: label of the the shellcheck program
29+
executable: label of the shellcheck program
3030
srcs: bash files to be linted
3131
config: label of the .shellcheckrc file
3232
stdout: output file containing stdout of shellcheck

0 commit comments

Comments
 (0)