You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
PR Review: docs: add missing commands to help view
Summary
This PR adds documentation for several command mode commands (:login, :theme, :autosave, :q) that were missing from the help view, and updates the command examples section. The changes are straightforward and improve the discoverability of these features.
Code Quality ✅
Clean and consistent: The changes follow the existing code structure and formatting patterns
Proper placement: New command documentation is logically placed in the "Command Mode" section alongside other command-mode keybindings
Consistent style: Uses the same s.key.Render() and s.desc.Render() pattern as existing entries
Verification ✅
I verified that all documented commands exist in the codebase:
:q - Implemented at internal/view/command_input.go:223
:login - Implemented at internal/view/command_input.go:244-258
:theme - Implemented at internal/view/command_input.go:296-303
:autosave - Implemented at internal/view/command_input.go:305-313
Observations
Positive aspects:
Improves user experience by documenting previously undocumented commands
The :login descriptions accurately reflect the implementation (default profile is "claws-login")
Command examples section was improved by replacing less useful examples with more practical ones
Minor inconsistencies noted (not blockers):
Line 157: Removed the :sort desc Age example - this is fine as it simplifies the examples, but users may want to know about the descending sort option
The help view already shows q as a quit key in the Navigation section (line 71), and now :q is also shown - this redundancy is acceptable as they're different methods to quit
Test Coverage ⚠️
The existing test file (internal/view/help_view_test.go) only has basic tests for creating the view and checking the status line. Consider adding a test that verifies all documented commands in the help text actually have corresponding implementations. However, this is not a blocker for this PR since:
This is a documentation-only change
All commands were manually verified to exist
The existing test coverage is minimal throughout
Performance Considerations ✅
No performance impact - only adds a few string literals to the rendered content
Security Concerns ✅
No security concerns - purely display/documentation changes
Recommendations
✅ Approve and merge - This is a good documentation improvement
💡 Optional follow-up: Consider documenting the desc option for the :sort command somewhere, since the example was removed
💡 Optional follow-up: Add integration tests that verify help documentation matches actual command implementations to prevent drift
Verdict
LGTM - Ready to merge! 🚀
This is a clean, well-executed documentation improvement that makes the application more user-friendly. The changes are accurate, consistent with the existing codebase, and enhance feature discoverability.
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
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.
Summary
:login,:theme,:autosave,:qto help view Command Mode sectionCloses #N/A (housekeeping)