-
Notifications
You must be signed in to change notification settings - Fork 2
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
Formatting issues with README #2
Comments
Thanks for reporting! Regarding the table truncation, it appears this is a rendering issue with how Github is rendering the table. Looking at other online markdown renderers and in VS code, the issue does not appear elsewhere. The way the table is resized appears to be contingent on the renderer - playing around with i.e. additional dashes or whitespace in the syntax does not change this behaviour in Github unfortunately. Typo for the word "omitted" corrected for an upcoming PR. Regarding the usage messages, I believe that this is the correct syntax for what I am trying to express: a mandatory argument that is either a filename or ("|") a directory.
Closing square brackets would indicate that the directory argument is optional, which is incorrect in my understanding. source
|
Oh yes, you are correct. I made a mistake. I somehow didn't catch the "directory" portion after --output and assumed that "filename | directory" was part of --output and that the "]" bracket was in the wrong place. |
Suggestions/typos for README.md file:
ommitted --> omitted
Typos in README:
The text was updated successfully, but these errors were encountered: