History

Joseph T. Lyons e50db1a4de Adds support to pretty format the json in `to json` (#1812 ) * Current work on the --pretty flag for to json * Deleted notes that were pushed by accident * Fixed some errors		2020-05-17 16:43:10 +12:00
..
alias.md	docs/commands: add alias.md (#1697 )	2020-05-03 16:49:27 +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
cal.md	cal: fix thursday typo (#1776 )	2020-05-13 08:06:31 -04: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	Add key_timeout config option (#1649 )	2020-04-25 05:28:38 +12: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
enter.md	[docs/enter] Warn about `enter` opening multiple shells (#1645 )	2020-04-24 12:17:11 +12: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	docs/commands: add from.md, update subcommands (#1712 )	2020-05-05 09:01:31 +12:00
from-ics.md	docs/commands: add from.md, update subcommands (#1712 )	2020-05-05 09:01:31 +12:00
from-ini.md	doc: add more from command pages (#1778 )	2020-05-14 05:23:33 +12:00
from-json.md	docs/commands: add from.md, update subcommands (#1712 )	2020-05-05 09:01:31 +12:00
from-ods.md	docs/commands: add from.md, update subcommands (#1712 )	2020-05-05 09:01:31 +12:00
from-toml.md	doc: add more from command pages (#1778 )	2020-05-14 05:23:33 +12:00
from-tsv.md	docs/commands: add from.md, update subcommands (#1712 )	2020-05-05 09:01:31 +12:00
from-url.md	doc: add more from command pages (#1778 )	2020-05-14 05:23:33 +12:00
from-vcf.md	Pick->Select rename. Integration tests changes. (#1725 )	2020-05-07 06:03:43 -05:00
from-xlsx.md	docs/commands: add from.md, update subcommands (#1712 )	2020-05-05 09:01:31 +12:00
from-xml.md	docs/commands: add from.md, update subcommands (#1712 )	2020-05-05 09:01:31 +12:00
from-yaml.md	docs/commands: add from.md, update subcommands (#1712 )	2020-05-05 09:01:31 +12:00
from.md	doc: add more from command pages (#1778 )	2020-05-14 05:23:33 +12: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
headers.md	doc: add headers command page (#1775 )	2020-05-13 20:03:29 +12: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
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
rename.md	doc: add rename command page (#1781 )	2020-05-14 12:36:08 +12:00
reverse.md	Fix whitespace and typos (#1481 )	2020-03-14 06:23:41 +13:00
save.md	Pick->Select rename. Integration tests changes. (#1725 )	2020-05-07 06:03:43 -05:00
select.md	Pick->Select rename. Integration tests changes. (#1725 )	2020-05-07 06:03:43 -05: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	Docs: Mention how to use `str --find-replace` in the docs. (#1653 )	2020-04-25 18:07:38 +12: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	docs/commands: add to.md, update subcommands (#1715 )	2020-05-05 20:05:23 +12:00
to-json.md	Adds support to pretty format the json in `to json` (#1812 )	2020-05-17 16:43:10 +12:00
to-toml.md	Use the directories crate instead of app_dirs (#1782 )	2020-05-14 20:17:23 +12:00
to-tsv.md	docs/commands: add to.md, update subcommands (#1715 )	2020-05-05 20:05:23 +12:00
to-url.md	doc: add more from command pages (#1778 )	2020-05-14 05:23:33 +12:00
to-yaml.md	docs/commands: add to.md, update subcommands (#1715 )	2020-05-05 20:05:23 +12:00
to.md	docs/commands: add to.md, update subcommands (#1715 )	2020-05-05 20:05:23 +12: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
update.md	doc: rename edit command to update (#1774 )	2020-05-13 20:02:41 +12: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
wrap.md	Pick->Select rename. Integration tests changes. (#1725 )	2020-05-07 06:03:43 -05:00

README.md

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.