docs(init): clarify --force behaviour in help and documentation
Metadata
Current evaluation
Clarified --force behavior in charmcraft init help text and documentation via PR 2971, correcting the misleading message about non-empty directories.
Resolution: closed resolved
Reason: The pull request was merged, updating the help text for the --force flag in charmcraft init to accurately reflect that it only bypasses file collisions.
Evaluated by: mr-cal-bot
No scores available.
Issue body
### Summary
The `--force` option in `charmcraft init` had help text indicating it was needed to `Initialize even if the directory is not empty (will not overwrite files)`. In reality, `charmcraft init` already allows non-empty directories as long as existing files do not conflict with the template. The `--force` flag is only required when files collide, in which case it permits initialisation without overwriting the conflicting files.
This change updates:
- The `--force` option help text and command overview in `charmcraft/application/commands/init.py`.
### Verification
- `make format`
- `make lint-code`
- `make test-fast`
Evaluation history
| Date | Model | Scores | Action | Summary |
|---|---|---|---|---|
| qwen/qwen3.6-35b-a3b | — | closed resolved | Clarified --force behavior in charmcraft init help text and documentation via PR 2971, correcting the misleading message about non-empty directories. | |
| qwen/qwen3.6-35b-a3b |
Impact:
15
Quick Win:
9
Complexity:
5
Confidence:
85
Actionability:
60
|
needs review | Clarifies --force help text for charmcraft init to accurately describe its behavior with conflicting files. Approved by 2 reviewers; one lint check failing. | |
| qwen/qwen3.6-35b-a3b |
Impact:
10
Quick Win:
6
Complexity:
5
Confidence:
70
Actionability:
60
|
needs review | Clarifies --force option help text in charmcraft init. Approved by 1 reviewer, but has a failing lint/files CI check and 1 unresolved comment. | |
| qwen/qwen3.6-35b-a3b |
Impact:
20
Quick Win:
15
Complexity:
5
Confidence:
85
Actionability:
80
|
needs review | Clarifies --force help text in charmcraft init to accurately describe its behavior when files collide. Clean 1-line change, CI passing, awaiting maintainer review. | |
| qwen/qwen3.6-35b-a3b |
Impact:
20
Quick Win:
15
Complexity:
5
Confidence:
85
Actionability:
80
|
needs review | Clarifies --force help text in charmcraft init to accurately describe its behavior when files collide. Clean 1-line change, CI passing, awaiting maintainer review. | |
| qwen/qwen3.6-35b-a3b |
Impact:
10
Quick Win:
8
Complexity:
5
Confidence:
85
Actionability:
80
|
needs review | Clarifies --force flag help text in charmcraft init to accurately describe its behavior with conflicting files. CI passing, awaiting maintainer review. | |
| qwen/qwen3.6-35b-a3b |
Impact:
10
Quick Win:
6
Complexity:
5
Confidence:
75
Actionability:
60
|
needs review | Clarifies --force help text in charmcraft init to correctly describe its behavior with conflicting files. Small doc change (+5/-1). CI failing on lint / files; awaiting review. | |
| qwen/qwen3.6-35b-a3b |
Impact:
10
Quick Win:
7
Complexity:
5
Confidence:
85
Actionability:
75
|
needs review | Clarifies --force option help text for charmcraft init; most CI passing, lint/files check failing | |
| qwen/qwen3.6-35b-a3b |
Impact:
25
Quick Win:
18
Complexity:
10
Confidence:
85
Actionability:
80
|
needs review | Clarifies --force behavior in charmcraft init help text and documentation across 4 files. CI passing, awaiting maintainer review. |
Update history
| Date | Change |
|---|---|
| merged | |
| updated | |
| updated | |
| updated | |
| updated | |
| updated | |
| updated | |
| updated | |
| updated | |
| created |
Related work
-
Related To:
canonical/charmcraft#2921
(confidence 80%)
Mentioned in PR comments as the discussion context for the --force flag behavior.
Related issues
| Issue | Project | State | Summary | Similarity |
|---|---|---|---|---|
| #200 Add force option to charmcraft init | charmcraft | merged | Merged in canonical/charmcraft#200 via 580773c4, adding --force to charmcraft init so it can initialize non-empty directories without overwriting files. |