From 539e232f3c5a319019cf48c2feea629542d338db Mon Sep 17 00:00:00 2001 From: Shaurya Shubham Date: Thu, 3 Oct 2019 19:07:48 +0530 Subject: [PATCH] Added docs for most of the to-sth commands Partial fix of issue #711 Docs for the following commands were added - to-csv to-json to-toml to-tsv to-url to-yaml Docs for to-db , to-bson , to-sqlite have not been added as I don't recognize and understand those formats. --- docs/commands/to-csv.md | 21 +++++++++++++++++++++ docs/commands/to-json.md | 18 ++++++++++++++++++ docs/commands/to-toml.md | 32 ++++++++++++++++++++++++++++++++ docs/commands/to-tsv.md | 20 ++++++++++++++++++++ docs/commands/to-url.md | 24 ++++++++++++++++++++++++ docs/commands/to-yaml.md | 27 +++++++++++++++++++++++++++ 6 files changed, 142 insertions(+) create mode 100644 docs/commands/to-csv.md create mode 100644 docs/commands/to-json.md create mode 100644 docs/commands/to-toml.md create mode 100644 docs/commands/to-tsv.md create mode 100644 docs/commands/to-url.md create mode 100644 docs/commands/to-yaml.md diff --git a/docs/commands/to-csv.md b/docs/commands/to-csv.md new file mode 100644 index 0000000000..983f1cde95 --- /dev/null +++ b/docs/commands/to-csv.md @@ -0,0 +1,21 @@ +# to-csv + +Converts table data into csv text. + +## Example + +```shell +> shells +━━━┯━━━┯━━━━━━━━━━━━┯━━━━━━━━━━━━━━━━━━━━━━━━ + # │ │ name │ path +───┼───┼────────────┼──────────────────────── + 0 │ X │ filesystem │ /home/shaurya + 1 │ │ filesystem │ /home/shaurya/Pictures + 2 │ │ filesystem │ /home/shaurya/Desktop +━━━┷━━━┷━━━━━━━━━━━━┷━━━━━━━━━━━━━━━━━━━━━━━━ +> shells | to-csv + ,name,path +X,filesystem,/home/shaurya + ,filesystem,/home/shaurya/Pictures + ,filesystem,/home/shaurya/Desktop +``` diff --git a/docs/commands/to-json.md b/docs/commands/to-json.md new file mode 100644 index 0000000000..f0e738d462 --- /dev/null +++ b/docs/commands/to-json.md @@ -0,0 +1,18 @@ +# to-json + +Converts table data into json text. + +## Example + +```shell +> shells +━━━┯━━━┯━━━━━━━━━━━━┯━━━━━━━━━━━━━━━━━━━━━━━━ + # │ │ name │ path +───┼───┼────────────┼──────────────────────── + 0 │ X │ filesystem │ /home/shaurya + 1 │ │ filesystem │ /home/shaurya/Pictures + 2 │ │ filesystem │ /home/shaurya/Desktop +━━━┷━━━┷━━━━━━━━━━━━┷━━━━━━━━━━━━━━━━━━━━━━━━ +> shells | to-json +[{" ":"X","name":"filesystem","path":"/home/shaurya"},{" ":" ","name":"filesystem","path":"/home/shaurya/Pictures"},{" ":" ","name":"filesystem","path":"/home/shaurya/Desktop"}] +``` diff --git a/docs/commands/to-toml.md b/docs/commands/to-toml.md new file mode 100644 index 0000000000..0690156184 --- /dev/null +++ b/docs/commands/to-toml.md @@ -0,0 +1,32 @@ +# to-toml + +Converts table data into toml text. + +## Example + +```shell +> shells +━━━┯━━━┯━━━━━━━━━━━━┯━━━━━━━━━━━━━━━━━━━━━━━━ + # │ │ name │ path +───┼───┼────────────┼──────────────────────── + 0 │ X │ filesystem │ /home/shaurya + 1 │ │ filesystem │ /home/shaurya/Pictures + 2 │ │ filesystem │ /home/shaurya/Desktop +━━━┷━━━┷━━━━━━━━━━━━┷━━━━━━━━━━━━━━━━━━━━━━━━ +> shells | to-toml +[[]] +" " = "X" +name = "filesystem" +path = "/home/shaurya" + +[[]] +" " = " " +name = "filesystem" +path = "/home/shaurya/Pictures" + +[[]] +" " = " " +name = "filesystem" +path = "/home/shaurya/Desktop" + +``` diff --git a/docs/commands/to-tsv.md b/docs/commands/to-tsv.md new file mode 100644 index 0000000000..ae2ade95c3 --- /dev/null +++ b/docs/commands/to-tsv.md @@ -0,0 +1,20 @@ +# to-tsv + +Converts table data into tsv text. + +## Example + +```shell +> shells +━━━┯━━━┯━━━━━━━━━━━━┯━━━━━━━━━━━━━━━━━━━━━━━━ + # │ │ name │ path +───┼───┼────────────┼──────────────────────── + 0 │ X │ filesystem │ /home/shaurya + 1 │ │ filesystem │ /home/shaurya/Pictures + 2 │ │ filesystem │ /home/shaurya/Desktop +━━━┷━━━┷━━━━━━━━━━━━┷━━━━━━━━━━━━━━━━━━━━━━━━ +> shells |to-tsv + name path +X filesystem /home/shaurya + +``` diff --git a/docs/commands/to-url.md b/docs/commands/to-url.md new file mode 100644 index 0000000000..b66057ed67 --- /dev/null +++ b/docs/commands/to-url.md @@ -0,0 +1,24 @@ +# to-url + +Converts table data into url-formatted text. + +## Example + +```shell +> shells +━━━┯━━━┯━━━━━━━━━━━━┯━━━━━━━━━━━━━━━━━━━━━━━━ + # │ │ name │ path +───┼───┼────────────┼──────────────────────── + 0 │ X │ filesystem │ /home/shaurya + 1 │ │ filesystem │ /home/shaurya/Pictures + 2 │ │ filesystem │ /home/shaurya/Desktop +━━━┷━━━┷━━━━━━━━━━━━┷━━━━━━━━━━━━━━━━━━━━━━━━ +> shells | to-url +━━━┯━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + # │ value +───┼─────────────────────────────────────────────────────── + 0 │ +=X&name=filesystem&path=%2Fhome%2Fshaurya + 1 │ +=+&name=filesystem&path=%2Fhome%2Fshaurya%2FPictures + 2 │ +=+&name=filesystem&path=%2Fhome%2Fshaurya%2FDesktop +━━━┷━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ +``` diff --git a/docs/commands/to-yaml.md b/docs/commands/to-yaml.md new file mode 100644 index 0000000000..90d6283ce3 --- /dev/null +++ b/docs/commands/to-yaml.md @@ -0,0 +1,27 @@ +# to-yaml + +Converts table data into yaml text. + +## Example + +```shell +> shells +━━━┯━━━┯━━━━━━━━━━━━┯━━━━━━━━━━━━━━━━━━━━━━━━ + # │ │ name │ path +───┼───┼────────────┼──────────────────────── + 0 │ X │ filesystem │ /home/shaurya + 1 │ │ filesystem │ /home/shaurya/Pictures + 2 │ │ filesystem │ /home/shaurya/Desktop +━━━┷━━━┷━━━━━━━━━━━━┷━━━━━━━━━━━━━━━━━━━━━━━━ +> shells | to-yaml +--- +- " ": X + name: filesystem + path: /home/shaurya +- " ": " " + name: filesystem + path: /home/shaurya/Pictures +- " ": " " + name: filesystem + path: /home/shaurya/Desktop +```