Improve messaging terminology: replace 'Completed' with 'Executed' #4507
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
…n all messaging - Update core message generation to use 'Executed:' instead of 'Completed:' - Change action start messages from 'Starting' to 'Executing' - Rename exec_starting constant to exec_executing for consistency - Update all test files to expect new message format - Update integration test fixtures with new terminology - Update documentation comments to reflect new messaging This improves clarity as 'Executed' accurately describes that an action ran regardless of outcome, while 'Executing' better conveys active operation.
There was a problem hiding this comment.
Pull Request Overview
This PR improves messaging terminology by replacing "Completed" with "Executed" and "Starting" with "Executing" to provide more semantically accurate action outcome descriptions. The current terminology was misleading because "Completed: Failed" suggests contradictory states, while "Executed: Failed" correctly conveys that an action was attempted but failed.
Key changes:
- Updated message property in
CompletionStateInfoto use "Executed:" prefix instead of "Completed:" - Changed action initiation messages from "Starting" to "Executing" in the logger decorator
- Renamed
exec_startingconstant toexec_executingfor consistency
Reviewed Changes
Copilot reviewed 18 out of 18 changed files in this pull request and generated no comments.
Show a summary per file
| File | Description |
|---|---|
| src/molecule/reporting.py | Updated message property to use "Executed:" prefix and corrected comment terminology |
| src/molecule/logger.py | Changed action start messages from "Starting" to "Executing" |
| src/molecule/constants.py | Renamed markup constant from "exec_starting" to "exec_executing" |
| src/molecule/ansi_output.py | Updated documentation comments to reflect new "Executed:" terminology |
| tests/unit/test_reporting.py | Updated test assertions to expect "Executed:" instead of "Completed:" |
| tests/unit/test_constants.py | Updated test to check for renamed "exec_executing" constant |
| tests/unit/test_ansi_output.py | Updated test cases to use new "Executed:" message format |
| tests/unit/command/test_*.py | Updated command test files to expect "Executed:" in log messages |
| tests/fixtures/integration/test_command/comprehensive_output.txt | Updated fixture output to reflect new messaging terminology |
| tests/conftest.py | Updated documentation comments to use new terminology |
|
just vocabulary, self approving since it was my doing in the first place |
cidrblock
added a commit
to cidrblock/molecule
that referenced
this pull request
Aug 11, 2025
…nsible#4507) ### Problem Statement The current messaging terminology uses "Completed" to describe action outcomes, which is semantically misleading. The term "Completed" implies successful full execution, but Molecule uses this prefix for all action outcomes including failures, early exits, missing files, and skipped operations. This creates confusion when reading logs, as "Completed: Failed" suggests contradictory states. Similarly, "Starting" suggests the beginning of an operation, while "Executing" more accurately conveys that the action is actively running. ### Solution Replace the misleading terminology throughout the codebase: - **"Completed:"** → **"Executed:"** for all action outcome messages - **"Starting"** → **"Executing"** for action initiation messages - **`exec_starting`** → **`exec_executing`** constant for consistency ### Technical Changes **Core Logic:** - `src/molecule/reporting.py`: Updated message property to use "Executed:" prefix - `src/molecule/logger.py`: Changed action start messages to "Executing" - `src/molecule/constants.py`: Renamed markup constant for semantic accuracy **Message Format Changes:** ```diff - INFO [default > converge] Starting - INFO [default > converge] Completed: Failed + INFO [default > converge] Executing + INFO [default > converge] Executed: Failed ``` **Test Coverage:** Updated 18 test files to reflect new message expectations, ensuring comprehensive validation of the terminology changes across all command types and output scenarios. ### Rationale **"Executed" is semantically accurate** because: - An action that fails has still been executed (attempted) - An action that exits early due to missing files has been executed - An action that is skipped has been executed (with skip logic) - The term describes the attempt/process rather than the outcome **"Executing" better conveys active operation** compared to "Starting" which suggests only initiation. ### Impact - **Improved clarity**: Eliminates semantic contradiction in failure scenarios - **Better debugging experience**: More intuitive log interpretation - **Professional terminology**: Aligns with standard software execution terminology - **Zero breaking changes**: Only affects user-visible messages, no API changes - **Full backward compatibility**: All existing functionality preserved ### Testing All existing tests updated and passing. The change is purely cosmetic to output messaging with no functional modifications to Molecule's behavior or interfaces.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Problem Statement
The current messaging terminology uses "Completed" to describe action outcomes, which is semantically misleading. The term "Completed" implies successful full execution, but Molecule uses this prefix for all action outcomes including failures, early exits, missing files, and skipped operations. This creates confusion when reading logs, as "Completed: Failed" suggests contradictory states.
Similarly, "Starting" suggests the beginning of an operation, while "Executing" more accurately conveys that the action is actively running.
Solution
Replace the misleading terminology throughout the codebase:
exec_starting→exec_executingconstant for consistencyTechnical Changes
Core Logic:
src/molecule/reporting.py: Updated message property to use "Executed:" prefixsrc/molecule/logger.py: Changed action start messages to "Executing"src/molecule/constants.py: Renamed markup constant for semantic accuracyMessage Format Changes:
Test Coverage:
Updated 18 test files to reflect new message expectations, ensuring comprehensive validation of the terminology changes across all command types and output scenarios.
Rationale
"Executed" is semantically accurate because:
"Executing" better conveys active operation compared to "Starting" which suggests only initiation.
Impact
Testing
All existing tests updated and passing. The change is purely cosmetic to output messaging with no functional modifications to Molecule's behavior or interfaces.