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: fix incorrect gazelle_generation_test param name #1876

Merged
merged 1 commit into from
Aug 20, 2024
Merged

docs: fix incorrect gazelle_generation_test param name #1876

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
2 changes: 1 addition & 1 deletion extend.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -177,7 +177,7 @@ To update the expected files, run `UPDATE_SNAPSHOTS=true bazel run //path/to:the
| <a id="gazelle_generation_test-test_data"></a>test_data | A list of target of the test data files you will pass to the test. This can be a https://bazel.build/reference/be/general#filegroup. | none |
| <a id="gazelle_generation_test-build_in_suffix"></a>build_in_suffix | The suffix for the input BUILD.bazel files. Defaults to .in. By default, will use files named BUILD.in as the BUILD files before running gazelle. | `".in"` |
| <a id="gazelle_generation_test-build_out_suffix"></a>build_out_suffix | The suffix for the expected BUILD.bazel files after running gazelle. Defaults to .out. By default, will use files named check the results of the gazelle run against files named BUILD.out. | `".out"` |
| <a id="gazelle_generation_test-gazelle_timeout_seconds"></a>gazelle_timeout_seconds | <p align="center"> - </p> | `2` |
| <a id="gazelle_generation_test-gazelle_timeout_seconds"></a>gazelle_timeout_seconds | Number of seconds to allow the gazelle process to run before killing. | `2` |
| <a id="gazelle_generation_test-size"></a>size | Specifies a test target's "heaviness": how much time/resources it needs to run. | `None` |
| <a id="gazelle_generation_test-kwargs"></a>kwargs | Attributes that are passed directly to the test declaration. | none |

Expand Down
2 changes: 1 addition & 1 deletion internal/generationtest/generationtest.bzl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,7 @@ def gazelle_generation_test(name, gazelle_binary, test_data, build_in_suffix = "
By default, will use files named BUILD.in as the BUILD files before running gazelle.
build_out_suffix: The suffix for the expected BUILD.bazel files after running gazelle. Defaults to .out.
By default, will use files named check the results of the gazelle run against files named BUILD.out.
timeout_seconds: Number of seconds to allow the gazelle process to run before killing.
gazelle_timeout_seconds: Number of seconds to allow the gazelle process to run before killing.
size: Specifies a test target's "heaviness": how much time/resources it needs to run.
**kwargs: Attributes that are passed directly to the test declaration.
"""
Expand Down