diff --git a/docs/buf.md b/docs/buf.md index 92f0a6a2..6aa949b0 100644 --- a/docs/buf.md +++ b/docs/buf.md @@ -13,6 +13,27 @@ buf = buf_lint_aspect( ``` + + +## buf_lint_action + +
+buf_lint_action(ctx, buf_toolchain, target, report) ++ +Runs the buf lint tool as a Bazel action. + +**PARAMETERS** + + +| Name | Description | Default Value | +| :------------- | :------------- | :------------- | +| ctx | Rule OR Aspect context | none | +| buf_toolchain | provides the buf-lint tool | none | +| target | the proto_library target to run on | none | +| report | output file to generate | none | + + ## buf_lint_aspect diff --git a/docs/flake8.md b/docs/flake8.md index 63853c83..094dac6b 100644 --- a/docs/flake8.md +++ b/docs/flake8.md @@ -53,14 +53,13 @@ A factory function to create a linter aspect. Attrs: binary: a flake8 executable. Can be obtained from rules_python like so: - ``` load("@rules_python//python/entry_points:py_console_script_binary.bzl", "py_console_script_binary") py_console_script_binary( name = "flake8", pkg = "@pip//flake8:pkg", ) - ``` + config: the flake8 config file (`setup.cfg`, `tox.ini`, or `.flake8`) **PARAMETERS**