From 15d17281026821b19acff378cd97a9b14b489211 Mon Sep 17 00:00:00 2001 From: kdestin <101366538+kdestin@users.noreply.github.com> Date: Mon, 2 Dec 2024 16:25:46 -0500 Subject: [PATCH] docs: `--root` is required for `tox run -e black` --- doc/eng_sys_checks.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/doc/eng_sys_checks.md b/doc/eng_sys_checks.md index e89dab76fcb8..aab03dffbe53 100644 --- a/doc/eng_sys_checks.md +++ b/doc/eng_sys_checks.md @@ -253,9 +253,9 @@ to opt into the black invocation. #### Running locally 1. Go to package root directory. -2. Execute command: `tox run -e black -c ../../../eng/tox/tox.ini -- .` +2. Execute command: `tox run -e black -c ../../../eng/tox/tox.ini --root . -- .` -**Tip**: You can provide any arguments that `black` accepts after the `--`. Example: `tox run -e black -c ../../../eng/tox/tox.ini -- path/to/file.py` +**Tip**: You can provide any arguments that `black` accepts after the `--`. Example: `tox run -e black -c ../../../eng/tox/tox.ini --root . -- path/to/file.py` ### Change log verification