8000 Update README.md by Zearin · Pull Request #824 · shelljs/shelljs · GitHub
[go: up one dir, main page]

Skip to content
8000

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

Closed
wants to merge 1 commit into from
Closed

Update README.md #824

wants to merge 1 commit into from

Conversation

Zearin
Copy link
Contributor
@Zearin Zearin commented Feb 8, 2018

Minor formatting tweaks

Minor formatting tweaks
8000
@nfischer
Copy link
Member
nfischer commented Feb 8, 2018

@Zearin Docs changes need to be done in src/*.js files first, then update the README using npm run gendocs

Copy link
Member
@nfischer nfischer left a 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)*.
Copy link
Member

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 ...])`
Copy link
Member

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?

Copy link
Contributor Author

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.
Copy link
Member

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

@Zearin
Copy link
Contributor Author
Zearin commented Feb 9, 2018

Whoops! That’s what I get for not looking more carefully. I’ll update the docs in src as you said.

@Zearin
Copy link
Contributor Author
Zearin commented Feb 9, 2018

Reopening as a new Pull Request…

@nfischer
7E7D Copy link
Member
nfischer commented Feb 9, 2018

You can always just add more commits to the same branch 😄

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 this pull request may close these issues.

2 participants
0