← Back to issue list

Please improve parameter documentation for `execute_run` -> `command`

View original Github issue

Metadata

Project
craft-parts
Number
#211
Type
issue
State
closed
Author
jugmac00
Labels
Created
Updated
Closed

Current evaluation

Closed as misreported. The documentation request belongs to the craft-providers repository. No action taken in this project.

Suggested action:

No scores available.

Issue body

The current docstring/param documentation looks like.. ``` :param command: Command to execute. ``` This is at very least not helpful. It is not a command, but a list of command parts - and yep, I can see it is a list when looking at the type annotations. There is still no description how these parts should look like. Anyhow, today I spent a bit too much time figuring out what I need to escape and what not. e.g. this command looks fine... ``` update_sources_list = [ "sed", "-i", f"'1s=^={lines}='", "/etc/apt/sources.list" ] ``` ... and even works when I join it and execute it, but it did not work when passing into `execute_run` as then some additional escaping happens, and the then assembled sed command was broken.

Evaluation history

Date Model Scores Action Summary
qwen/qwen3.6-35b-a3b Closed as misreported. The documentation request belongs to the craft-providers repository. No action taken in this project.
qwen/qwen3.6-35b-a3b Author closed the issue as misplaced, redirecting the documentation request to the craft-providers repository. The request to clarify command escaping and list formatting remains unresolved here.
qwen/qwen3.6-35b-a3b Closed by author as misfiled. The request to improve execute_run command parameter documentation was redirected to the craft-providers repository for tracking.
qwen3.6-35b-a3b-mtp-q6 Abandoned here and superseded by a report in craft-providers. The author closed the issue, noting the documentation request belongs in that upstream repository.

Update history

No update history recorded yet.

Related issues

No related issues found above the similarity threshold.