Skip to content

Refactored the help functions. #1478

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Merged
merged 4 commits into from
Aug 19, 2025
Merged

Refactored the help functions. #1478

merged 4 commits into from
Aug 19, 2025

Conversation

kmvanbrunt
Copy link
Member

No description provided.

@kmvanbrunt kmvanbrunt requested a review from tleonhardt as a code owner August 19, 2025 19:34
@codecov Codecov
Copy link

codecov bot commented Aug 19, 2025 •
edited
Loading

Codecov Report

❌ Patch coverage is 98.73418% with 1 line in your changes missing coverage. Please review.
✅ Project coverage is 98.60%. Comparing base (2ef7b9a) to head (837a3d4).
⚠️ Report is 1 commits behind head on main.

Files with missing lines Patch % Lines
cmd2/cmd2.py 98.71% 1 Missing ⚠️
Additional details and impacted files 
@@            Coverage Diff             @@
##             main    #1478      +/-   ##
==========================================
+ Coverage   98.48%   98.60%   +0.12%     
==========================================
  Files          23       23              
  Lines        4884     4885       +1     
==========================================
+ Hits         4810     4817       +7     
+ Misses         74       68       -6
Flag Coverage Δ
unittests 98.60% <98.73%> (+0.12%) ⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

tleonhardt
tleonhardt requested changes Aug 19, 2025
View reviewed changes
Copy link
Member

@tleonhardt tleonhardt left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Need to improve HelpApp class in test_cmd2.py to better coverage the stuff that is intended.

tleonhardt
tleonhardt previously approved these changes Aug 19, 2025
View reviewed changes
cmd2/cmd2.py
if not cmds:
return

if not verbose:
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice cleanup. Consider taking it further and doing:

if not verbose:
    self.print_topics(header, cmds, 15, 80)
    return

And then getting rid of the else: block and un-indenting the rest of the code to the main level.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Done

@kmvanbrunt kmvanbrunt merged commit c8a8935 into main Aug 19, 2025
30 checks passed
@kmvanbrunt kmvanbrunt deleted the refactor_help branch August 19, 2025 21:06
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@tleonhardt tleonhardt tleonhardt approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@kmvanbrunt @tleonhardt