Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

docs: clarify what's not recommended #264

Merged
merged 2 commits into from
May 30, 2024
Merged

docs: clarify what's not recommended #264

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
22af391
docs: clarify what's not recommended
alexeagle May 30, 2024
d5f54af
update docgen
alexeagle May 30, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions docs/format.md
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

4 changes: 2 additions & 2 deletions format/defs.bzl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -97,7 +97,7 @@ def format_multirun(name, jobs = 4, print_command = False, **kwargs):
This macro produces a target named `[name].check` which does not edit files,
rather it exits non-zero if any sources require formatting.

Not recommended: to check formatting with `bazel test`, use [format_test](#format_test) instead.
To check formatting with `bazel test`, use [format_test](#format_test) instead.

[multirun]: https://registry.bazel.build/modules/rules_multirun

Expand Down Expand Up @@ -146,7 +146,7 @@ def format_test(name, srcs = None, workspace = None, no_sandbox = False, disable
"""Create test for the given formatters.

Intended to be used with `bazel test` to verify files are formatted.
This is not recommended, because it is either non-hermetic or requires listing all source files.
**This is not recommended**, because it is either non-hermetic or requires listing all source files.

To format with `bazel run`, see [format_multirun](#format_multirun).

Expand Down
Loading