nushell/docs/commands
Jonathan Turner c4daa2e40f
Add experimental new parser (#1554)
Move to an experimental new parser
2020-04-06 19:16:14 +12:00
..
append.md Fix whitespace and typos (#1481) 2020-03-14 06:23:41 +13:00
average.md Fix whitespace and typos (#1481) 2020-03-14 06:23:41 +13:00
calc.md Fix whitespace and typos (#1481) 2020-03-14 06:23:41 +13:00
cd.md Add documentation for cd - 2019-10-08 18:32:42 +11:00
compact.md Fix whitespace and typos (#1481) 2020-03-14 06:23:41 +13:00
config.md Updated rustyline to 6.0.0. Added completion_mode config (#1289) 2020-01-27 16:41:17 +13:00
count.md Fix whitespace and typos (#1481) 2020-03-14 06:23:41 +13:00
date.md Fix typo in date.cmd 2019-10-01 11:21:56 -03:00
debug.md Fix whitespace and typos (#1481) 2020-03-14 06:23:41 +13:00
default.md Fix whitespace and typos (#1481) 2020-03-14 06:23:41 +13:00
du.md Fix whitespace and typos (#1481) 2020-03-14 06:23:41 +13:00
echo.md Add echo command documentation 2019-10-01 06:14:56 -04:00
edit.md Fix whitespace and typos (#1481) 2020-03-14 06:23:41 +13:00
enter.md Add documentation for the enter command 2019-10-07 23:21:58 +08:00
exit.md Fix whitespace and typos (#1481) 2020-03-14 06:23:41 +13:00
fetch.md Add documentation for the fetch command 2019-10-07 02:17:57 +08:00
first.md add documentation file for first command 2019-10-02 15:49:44 -04:00
format.md add documentation for format 2019-12-02 11:02:59 -08:00
from-csv.md Fix whitespace and typos (#1481) 2020-03-14 06:23:41 +13:00
from-ics.md Add documentation for from-ics and from-vcf (#1509) 2020-03-21 14:50:13 +13:00
from-json.md Fix whitespace and typos (#1481) 2020-03-14 06:23:41 +13:00
from-ods.md Fix whitespace and typos (#1481) 2020-03-14 06:23:41 +13:00
from-toml.md Create docs for from-toml command 2019-10-25 20:47:00 +02:00
from-tsv.md add documentation for from-tsv, from-xml 2019-12-02 11:02:58 -08:00
from-vcf.md Add documentation for from-ics and from-vcf (#1509) 2020-03-21 14:50:13 +13:00
from-xlsx.md Fix whitespace and typos (#1481) 2020-03-14 06:23:41 +13:00
from-xml.md add documentation for from-tsv, from-xml 2019-12-02 11:02:58 -08:00
from-yaml.md add documentation for from-json, from-yaml, history, split-row 2019-12-02 11:02:59 -08:00
get.md Fix whitespace and typos (#1481) 2020-03-14 06:23:41 +13:00
group-by.md Fix whitespace and typos (#1481) 2020-03-14 06:23:41 +13:00
help.md Fix whitespace and typos (#1481) 2020-03-14 06:23:41 +13:00
histogram.md Fix whitespace and typos (#1481) 2020-03-14 06:23:41 +13:00
history.md Fix whitespace and typos (#1481) 2020-03-14 06:23:41 +13:00
inc.md Fix whitespace and typos (#1481) 2020-03-14 06:23:41 +13:00
insert.md Fix whitespace and typos (#1481) 2020-03-14 06:23:41 +13:00
last.md fix grammar 2019-10-03 08:18:51 -04:00
lines.md Fix whitespace and typos (#1481) 2020-03-14 06:23:41 +13:00
nth.md Fix whitespace and typos (#1481) 2020-03-14 06:23:41 +13:00
open.md Add documentation for the open command 2019-10-07 02:08:20 +08:00
pick.md Fix whitespace and typos (#1481) 2020-03-14 06:23:41 +13:00
pivot.md Document pivot command 2019-11-14 16:59:39 -05:00
prepend.md Fix whitespace and typos (#1481) 2020-03-14 06:23:41 +13:00
ps.md add documentation for get, ps 2019-12-02 11:02:58 -08:00
README.md More command documentation instructions. 2019-09-25 11:35:58 -05:00
reject.md Fix whitespace and typos (#1481) 2020-03-14 06:23:41 +13:00
reverse.md Fix whitespace and typos (#1481) 2020-03-14 06:23:41 +13:00
save.md fix error in save.md 2019-12-02 11:02:59 -08:00
shells.md Fix whitespace and typos (#1481) 2020-03-14 06:23:41 +13:00
size.md Fix whitespace and typos (#1481) 2020-03-14 06:23:41 +13:00
skip-while.md Add documentation for skip and skip-while (#1499) 2020-03-18 14:22:35 +13:00
skip.md Add documentation for skip and skip-while (#1499) 2020-03-18 14:22:35 +13:00
sort-by.md Fix whitespace and typos (#1481) 2020-03-14 06:23:41 +13:00
split-column.md Fix whitespace and typos (#1481) 2020-03-14 06:23:41 +13:00
split-row.md Fix whitespace and typos (#1481) 2020-03-14 06:23:41 +13:00
str.md Updated Doc, error on bad input 2019-11-01 17:25:08 -05:00
sum.md Fix whitespace and typos (#1481) 2020-03-14 06:23:41 +13:00
sys.md Fixes #1204 : sys | get host.users displays the same user (#1480) 2020-03-12 14:01:55 +13:00
tags.md update links to books 2019-12-15 13:56:26 +01:00
to-csv.md combine functions behind to/from-c/tsv commands 2019-11-19 16:02:35 +00:00
to-json.md Fix whitespace and typos (#1481) 2020-03-14 06:23:41 +13:00
to-toml.md Add experimental new parser (#1554) 2020-04-06 19:16:14 +12:00
to-tsv.md Fix whitespace and typos (#1481) 2020-03-14 06:23:41 +13:00
to-url.md Fix whitespace and typos (#1481) 2020-03-14 06:23:41 +13:00
to-yaml.md Fix whitespace and typos (#1481) 2020-03-14 06:23:41 +13:00
trim.md Add documentation for the trim command 2019-10-06 22:35:38 +08:00
uniq.md Use proper file extension for uniq command docs (#1411) 2020-02-18 09:37:46 -05:00
version.md Fix whitespace and typos (#1481) 2020-03-14 06:23:41 +13:00
where.md Fix whitespace and typos (#1481) 2020-03-14 06:23:41 +13:00
which.md Slightly improve new which command (#1145) 2020-01-01 20:47:25 +13:00

How do I get started?

Pick any command from the checklist and write a comment acknowledging you started work.

Instructions for documenting a Nu command of your choosing

Name the file after the command, like so:

command.md

Example: If you want to add documentation for the Nu command enter, create a file named enter.md, write documentation, save it at /docs/commands/[your_command_picked].md as and create your pull request.

What kind of documentation should I write?

Anything you want that you believe it best documents the command and the way you would like to see it. Here are some of our ideas of documentation we would love to see (feel free to add yours):

  • Examples of using the command (max creativity welcomed!)
  • Description of the command.
  • Command usage.

Anything else?

Of course! (These are drafts) so feel free to leave feedback and suggestions in the same file.

Happy Documenting.