Update readme - #1739
Open
tleonhardt wants to merge 8 commits into
Open
Conversation
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #1739 +/- ##
=======================================
Coverage 99.66% 99.66%
=======================================
Files 23 23
Lines 5960 5960
=======================================
Hits 5940 5940
Misses 20 20
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Harness. |
…ntax for specifying command arguments using type annotations
… the getting_started.py example Also added a simple animated gif to that page.
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
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.
For a long time I've felt like our top-level README needed a major overhaul.
I felt like it was light on useful information and delayed some of the most useful info until far down the page.
This moves the quickstart example much higher up, has it use the annoated decorator, adds an animated gif of using that toy application and removes the other images that were there.
It also attempts to put our best foot forward in the
Why cmd2?section and does a better job of highlighting key features to aid with discoverability for new users.Also:
getting_started.mddocumentation page to more closely match the current state of thegetting_started.pyexample and added a simple animated gif.