Skip to content

Commit

Permalink
Update buck_workspace inline docs
Browse files Browse the repository at this point in the history
Summary: Docs for `buck_test` parameters were a bit scattered, unifying them against as it seems like what we had before

Reviewed By: scottcao

Differential Revision: D62526190

fbshipit-source-id: cd43aa662d1c163b979d580fc650b0d4ddca95a7
  • Loading branch information
Will-MingLun-Li authored and facebook-github-bot committed Sep 13, 2024
1 parent f71b2b8 commit a6f79d9
Showing 1 changed file with 8 additions and 2 deletions.
10 changes: 8 additions & 2 deletions tests/e2e_util/buck_workspace.py
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,6 @@
"allow_soft_errors",
"extra_buck_config",
"skip_final_kill",
# Whether or not to set up an EdenFS repo for this test. Only matters for inplace=False.
"setup_eden",
],
)
Expand Down Expand Up @@ -438,7 +437,6 @@ def buck_test(
skip_for_os: List[str] = [], # noqa: B006 value is read-only
allow_soft_errors=False,
extra_buck_config: Optional[Dict[str, Dict[str, str]]] = None,
# Don't run a `buck2 kill` or `buck2 clean` at the end of the test
skip_final_kill=False,
setup_eden=False,
) -> Callable:
Expand All @@ -461,6 +459,14 @@ def buck_test(
List of OS to skip the test on.
allow_soft_errors:
Like it says in the arg name. The default is to hard error.
extra_buck_config:
A optional dict of extra buck config to add to the test.
The key is the section name, the value is a dict of key value pairs.
skip_final_kill:
Don't run a `buck2 kill` or `buck2 clean` at the end of the test
setup_eden:
Whether or not to set up an EdenFS repo for this test. Only matters for inplace=False.
Note that this will slow the test down, so it should not be widely enabled.
"""

if inplace and data_dir == "":
Expand Down

0 comments on commit a6f79d9

Please sign in to comment.