-
Notifications
You must be signed in to change notification settings - Fork 738
Update README.md #824
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
Update README.md #824
Conversation
Minor formatting tweaks
@Zearin Docs changes need to be done in |
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.
Overall pretty good. Thanks for catching these mistakes!
A FILE argument that does not exist is created empty, unless -c is supplied. | ||
This is a partial implementation of *[touch(1)](http://linux.die.net/man/1/touch)*. | ||
A FILE argument that does not exist is created empty, unless `-c` is supplied. | ||
This is a partial implementation of *[`touch(1)`](http://linux.die.net/man/1/touch)*. |
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.
If we're using backtick formatting, let's remove the italics
|
||
|
||
### echo([options,] string [, string ...]) | ||
### `echo([options,] string [, string ...])` |
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 looks a bit better with the headers as-is. Were there any formatting bugs I'm overlooking?
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.
No. I just prefer the monospace font for any documentation that is referencing a command/option/option-value.
But I can omit this when I redo the Pull Request. :)
@@ -400,11 +400,11 @@ ln('file', 'newlink'); | |||
ln('-sf', 'file', 'existing'); | |||
``` | |||
|
|||
Links source to dest. Use -f to force the link, should dest already exist. | |||
Links source to dest. Use `-f` to force the link, should `dest` already exist. |
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.
Also wrap source
and dest
in backticks
Whoops! That’s what I get for not looking more carefully. I’ll update the docs in src as you said. |
Reopening as a new Pull Request… |
You can always just add more commits to the same branch 😄 |
Minor formatting tweaks