Skip to content

Commit 52cda5d

Browse files
committed
Fix Tool.exec_direct docstring
As per apposed/appose-java@9e62284.
1 parent b536c00 commit 52cda5d

File tree

1 file changed

+6
-2
lines changed

1 file changed

+6
-2
lines changed

src/appose/tool/__init__.py

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -198,8 +198,12 @@ def exec(self, *args: str, cwd: Path | None = None) -> None:
198198

199199
def _exec_direct(self, *args: str) -> None:
200200
"""
201-
Executes a tool command without validating installation,
202-
without passing output to external listeners, and without including flags.
201+
Executes a tool command with the specified arguments, without validating the
202+
tool installation beforehand, without passing output to external listeners
203+
(see set_output_consumer and set_error_consumer), and without including flags.
204+
205+
This method mainly exists for version() checking, and subclasses of Tool are
206+
unlikely to need it—they should probably use exec(...) instead.
203207
204208
Args:
205209
*args: Command arguments for the tool.

0 commit comments

Comments
 (0)