-
Notifications
You must be signed in to change notification settings - Fork 5
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.
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
Implement help command #76
Implement help command #76
Conversation
So that the PrimitiveCommandParser can focus on parsing. Generating help is sort of a different responsibility
it works now
Codecov Report
@@ Coverage Diff @@
## master #76 +/- ##
============================================
+ Coverage 72.58% 73.21% +0.63%
- Complexity 415 425 +10
============================================
Files 73 73
Lines 1375 1400 +25
Branches 107 110 +3
============================================
+ Hits 998 1025 +27
+ Misses 337 335 -2
Partials 40 40
Continue to review full report at Codecov.
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM!
Works on My Windows Machine too
Will make this a not draft after I add some tests or something maybe The code is mostly formatting text to be printed so I dont think unit tests will benefit it much |
Might need to change the logger message in ui/HelpWindow.java and remove the function that shows the help screen |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think it only needs some minor changes. Other than that, everything LGTM
We don't really need unit tests because help just formats text
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM
Closes #76
Automatically generate help using the already existing information in the Command's parameters.
Changes to commands
Added a new (implicitly) required constant String for each command,
SHORT_DESCRIPTION
which will be used in generatinghelp
.We will follow the same convention as commits for these descriptions.
Will use this value when adding new commands to the
PrimitiveCommandParser
(where you have to add it is obvious when viewing the code).Future todos?
Will have to add docs to the DG for how this works.
The UI
help
button still works and shows the old help popup. May have to remove this but we can do this in a separate issue.