Skip to content

Conversation

tleonhardt
Copy link
Member

@tleonhardt tleonhardt commented Sep 13, 2025

Fix consistency, grammar, and spelling issues in documentation as well as some outdated info.

I made a detailed first-pass through the documentation focused on grammar, spelling, and consistency issues. I made a weak attempt to also correct any info which was very obviously outdated.

The documentation will definitely need another pass prior to the 3.0.0 release to make sure it adequately covers cmd2 in its current state. But this is an attempt to cleanup some of the low-hanging fruit first.

Copy link

codecov bot commented Sep 13, 2025

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 98.81%. Comparing base (37b1b7d) to head (1de99e5).
⚠️ Report is 1 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff             @@
##             main    #1509      +/-   ##
==========================================
+ Coverage   98.79%   98.81%   +0.02%     
==========================================
  Files          23       23              
  Lines        4961     4961              
==========================================
+ Hits         4901     4902       +1     
+ Misses         60       59       -1     
Flag Coverage Δ
unittests 98.81% <ø> (+0.02%) ⬆️

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 merged commit 6032995 into main Sep 13, 2025
30 checks passed
@tleonhardt tleonhardt deleted the doc-improvements branch September 13, 2025 16:23
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants