From efc0bbb4ec40ce720b19e2fc190cb88b1da32afb Mon Sep 17 00:00:00 2001 From: Nate Fischer Date: Thu, 14 Jan 2016 03:19:39 -0800 Subject: [PATCH] style: make docs more consistent I also fixed a URL in the top section of the README. --- README.md | 20 ++++++++++---------- src/ln.js | 4 ++-- src/mkdir.js | 2 +- src/mv.js | 2 +- src/touch.js | 10 +++++----- 5 files changed, 19 insertions(+), 19 deletions(-) diff --git a/README.md b/README.md index 980f536..81a4533 100644 --- a/README.md +++ b/README.md @@ -3,7 +3,7 @@ ShellJS is a portable **(Windows/Linux/OS X)** implementation of Unix shell commands on top of the Node.js API. You can use it to eliminate your shell script's dependency on Unix while still keeping its familiar and powerful commands. You can also install it globally so you can run it from outside Node projects - say goodbye to those gnarly Bash scripts! -The project is [unit-tested](http://travis-ci.org/arturadib/shelljs) and battled-tested in projects like: +The project is [unit-tested](http://travis-ci.org/shelljs/shelljs) and battled-tested in projects like: + [PDF.js](http://github.com/mozilla/pdf.js) - Firefox's next-gen PDF reader + [Firebug](http://getfirebug.com/) - Firefox's infamous debugger @@ -239,7 +239,7 @@ Removes files. The wildcard `*` is accepted. ### mv(source_array, dest') Available options: -+ `f`: force ++ `-f`: force Examples: @@ -256,7 +256,7 @@ Moves files. The wildcard `*` is accepted. ### mkdir([options ,] dir_array) Available options: -+ `p`: full path (will create intermediate dirs if necessary) ++ `-p`: full path (will create intermediate dirs if necessary) Examples: @@ -453,8 +453,8 @@ See also: pushd, popd ### ln(source, dest) Available options: -+ `s`: symlink -+ `f`: force ++ `-s`: symlink ++ `-f`: force Examples: @@ -535,11 +535,11 @@ Notable exceptions: ### touch([options ,] file) Available options: -+ `'-a'`: Change only the access time -+ `'-c'`: Do not create any files -+ `'-m'`: Change only the modification time -+ `'-d DATE'`: Parse DATE and use it instead of current time -+ `'-r FILE'`: Use FILE's times instead of current time ++ `-a`: Change only the access time ++ `-c`: Do not create any files ++ `-m`: Change only the modification time ++ `-d DATE`: Parse DATE and use it instead of current time ++ `-r FILE`: Use FILE's times instead of current time Examples: diff --git a/src/ln.js b/src/ln.js index a7b9701..92e4b35 100644 --- a/src/ln.js +++ b/src/ln.js @@ -8,8 +8,8 @@ var os = require('os'); //@ ### ln(source, dest) //@ Available options: //@ -//@ + `s`: symlink -//@ + `f`: force +//@ + `-s`: symlink +//@ + `-f`: force //@ //@ Examples: //@ diff --git a/src/mkdir.js b/src/mkdir.js index 5a7088f..92356fc 100644 --- a/src/mkdir.js +++ b/src/mkdir.js @@ -24,7 +24,7 @@ function mkdirSyncRecursive(dir) { //@ ### mkdir([options ,] dir_array) //@ Available options: //@ -//@ + `p`: full path (will create intermediate dirs if necessary) +//@ + `-p`: full path (will create intermediate dirs if necessary) //@ //@ Examples: //@ diff --git a/src/mv.js b/src/mv.js index 11f9607..02be9c5 100644 --- a/src/mv.js +++ b/src/mv.js @@ -7,7 +7,7 @@ var common = require('./common'); //@ ### mv(source_array, dest') //@ Available options: //@ -//@ + `f`: force +//@ + `-f`: force //@ //@ Examples: //@ diff --git a/src/touch.js b/src/touch.js index 38415a5..14a1289 100644 --- a/src/touch.js +++ b/src/touch.js @@ -5,11 +5,11 @@ var fs = require('fs'); //@ ### touch([options ,] file) //@ Available options: //@ -//@ + `'-a'`: Change only the access time -//@ + `'-c'`: Do not create any files -//@ + `'-m'`: Change only the modification time -//@ + `'-d DATE'`: Parse DATE and use it instead of current time -//@ + `'-r FILE'`: Use FILE's times instead of current time +//@ + `-a`: Change only the access time +//@ + `-c`: Do not create any files +//@ + `-m`: Change only the modification time +//@ + `-d DATE`: Parse DATE and use it instead of current time +//@ + `-r FILE`: Use FILE's times instead of current time //@ //@ Examples: //@