Add man page; improve CLI ergonomics; simplify config docs - #9
Merged
Conversation
One instance of “licence“ is changed to match the predominant spelling variant “license.”
While “uARMSolver arm.set” would work, it would do so only because “arm.set” is the default setup file name/path, and extra positional arguments are ignored.
This makes the command-line interface a little more conventional and ergonomic.
This is much less confusing than silently ignoring them.
Owner
|
Ben, this is brilliant! Great! Many thanks. |
Closed
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
2 participants
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.
As requested in #8, this PR contains a man page.
It also contains a few typo fixes.
I suggested a couple of compatible improvements to the command-line option parsing that I think would make using the command simpler and less surprising.
In the final commit, I heavily edited the configuration file documentation for simplicity and clarity. You didn’t ask me to do that, and I am happy to revert or further modify this commit if you’re not happy with the result. However, I think there is a good chance that you will find it to be an improvement.
I’m happy to accept any feedback and make further revisions if needed.