Skip to content
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

Closed
mismathh opened this issue Sep 15, 2023 · 2 comments · Fixed by #7
Closed

Formatting issues with README #2

mismathh opened this issue Sep 15, 2023 · 2 comments · Fixed by #7

Comments

@mismathh
Copy link
Contributor

Suggestions/typos for README.md file:

  • For the Command Line Arguments table, some of the arguments are getting cut off and pushed to a new line. Might need to play around with the spacings of the table to correct it.
  • Within same table mentioned above, there is a typo within the description of the --output argument
    ommitted --> omitted
  • Missing closing brackets in code blocks under Usage heading

Typos in README:

README Formatting Issues

@paulkim26
Copy link
Owner

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.

til-to-html [-h | --help] [-v | --version] [-o | --output directory] filename | directory

Closing square brackets would indicate that the directory argument is optional, which is incorrect in my understanding. source

til-to-html [-h | --help] [-v | --version] [-o | --output directory] [filename | directory]

This was referenced Sep 16, 2023
Merged
@mismathh
Copy link
Contributor Author

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.

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 a pull request may close this issue.

2 participants