nushell/docs/commands
Eli Flanagan 4ed615cfcc
documentation: consistent abbreviation for URL (#3684)
I noticed `fetch`'s documentation used "URL" so wanted to do so here as
well.
2021-06-25 09:14:20 -05:00
..
alias.md Update alias docs (#2925) 2021-01-13 14:46:15 +13:00
all.md Autogenerate missing docs (#3514) 2021-05-30 12:57:04 +12:00
ansi-strip.md Autogenerate missing docs (#3514) 2021-05-30 12:57:04 +12:00
ansi.md Autogenerate missing docs (#3514) 2021-05-30 12:57:04 +12:00
any.md Autogenerate missing docs (#3514) 2021-05-30 12:57:04 +12:00
append.md Allow appending table literals. (#2693) 2020-10-22 03:26:30 -05:00
autoenv-trust.md Autogenerate missing docs (#3514) 2021-05-30 12:57:04 +12:00
autoenv-untrust.md Autogenerate missing docs (#3514) 2021-05-30 12:57:04 +12:00
autoenv.md Autogenerate missing docs (#3514) 2021-05-30 12:57:04 +12:00
autoview.md Simplify expressions (#3389) 2021-05-12 13:01:48 +12:00
benchmark.md Autogenerate missing docs (#3514) 2021-05-30 12:57:04 +12:00
binaryview.md Autogenerate missing docs (#3514) 2021-05-30 12:57:04 +12:00
build-string.md Autogenerate missing docs (#3514) 2021-05-30 12:57:04 +12:00
cal.md Fix cal command week-start example (#2040) 2020-06-24 17:15:19 +12:00
cd.md Add documentation for cd - 2019-10-08 18:32:42 +11:00
char.md Autogenerate missing docs (#3514) 2021-05-30 12:57:04 +12:00
chart-bar.md Autogenerate missing docs (#3514) 2021-05-30 12:57:04 +12:00
chart-line.md Autogenerate missing docs (#3514) 2021-05-30 12:57:04 +12:00
chart.md Autogenerate missing docs (#3514) 2021-05-30 12:57:04 +12:00
clear.md Autogenerate missing docs (#3514) 2021-05-30 12:57:04 +12:00
clip.md Autogenerate missing docs (#3514) 2021-05-30 12:57:04 +12:00
compact.md First pass at updating all documentation formatting and cleaning up output of examples (#2031) 2020-06-24 06:21:47 +12:00
config-clear.md Autogenerate missing docs (#3514) 2021-05-30 12:57:04 +12:00
config-get.md Autogenerate missing docs (#3514) 2021-05-30 12:57:04 +12:00
config-path.md Autogenerate missing docs (#3514) 2021-05-30 12:57:04 +12:00
config-remove.md Autogenerate missing docs (#3514) 2021-05-30 12:57:04 +12:00
config-set_into.md Autogenerate missing docs (#3514) 2021-05-30 12:57:04 +12:00
config-set.md Autogenerate missing docs (#3514) 2021-05-30 12:57:04 +12:00
config.md update config documentation (#2178) 2020-07-23 09:42:04 +12:00
cp.md Autogenerate missing docs (#3514) 2021-05-30 12:57:04 +12:00
date-format.md Autogenerate missing docs (#3514) 2021-05-30 12:57:04 +12:00
date-list-timezone.md Autogenerate missing docs (#3514) 2021-05-30 12:57:04 +12:00
date-now.md Autogenerate missing docs (#3514) 2021-05-30 12:57:04 +12:00
date-to-table.md Autogenerate missing docs (#3514) 2021-05-30 12:57:04 +12:00
date-to-timezone.md Autogenerate missing docs (#3514) 2021-05-30 12:57:04 +12:00
date.md First pass at updating all documentation formatting and cleaning up output of examples (#2031) 2020-06-24 06:21:47 +12:00
debug.md Size command: rename max length to bytes (#2473) 2020-09-01 14:51:35 +12:00
def.md Fix typos and capitalization of "Unicode" (#3234) 2021-04-04 07:14:07 +12:00
default.md First pass at updating all documentation formatting and cleaning up output of examples (#2031) 2020-06-24 06:21:47 +12:00
describe.md Autogenerate missing docs (#3514) 2021-05-30 12:57:04 +12:00
do.md Autogenerate missing docs (#3514) 2021-05-30 12:57:04 +12:00
drop-column.md Autogenerate missing docs (#3514) 2021-05-30 12:57:04 +12:00
drop.md Autogenerate missing docs (#3514) 2021-05-30 12:57:04 +12:00
du.md First pass at updating all documentation formatting and cleaning up output of examples (#2031) 2020-06-24 06:21:47 +12:00
each-group.md Autogenerate missing docs (#3514) 2021-05-30 12:57:04 +12:00
each-window.md Autogenerate missing docs (#3514) 2021-05-30 12:57:04 +12:00
each.md Autogenerate missing docs (#3514) 2021-05-30 12:57:04 +12:00
echo.md First pass at updating all documentation formatting and cleaning up output of examples (#2031) 2020-06-24 06:21:47 +12:00
empty.md Simplify expressions (#3389) 2021-05-12 13:01:48 +12:00
enter.md First pass at updating all documentation formatting and cleaning up output of examples (#2031) 2020-06-24 06:21:47 +12:00
every.md First pass at updating all documentation formatting and cleaning up output of examples (#2031) 2020-06-24 06:21:47 +12:00
exec.md Autogenerate missing docs (#3514) 2021-05-30 12:57:04 +12:00
exit.md First pass at updating all documentation formatting and cleaning up output of examples (#2031) 2020-06-24 06:21:47 +12:00
fetch.md First pass at updating all documentation formatting and cleaning up output of examples (#2031) 2020-06-24 06:21:47 +12:00
first.md First pass at updating all documentation formatting and cleaning up output of examples (#2031) 2020-06-24 06:21:47 +12:00
flatten.md Autogenerate missing docs (#3514) 2021-05-30 12:57:04 +12:00
for.md Autogenerate missing docs (#3514) 2021-05-30 12:57:04 +12:00
format-filesize.md Autogenerate missing docs (#3514) 2021-05-30 12:57:04 +12:00
format.md First pass at updating all documentation formatting and cleaning up output of examples (#2031) 2020-06-24 06:21:47 +12:00
from-bson.md Autogenerate missing docs (#3514) 2021-05-30 12:57:04 +12:00
from-csv.md Update documentation to properly refer to subcommands with spaces (#2164) 2020-07-13 18:39:36 +12:00
from-eml.md Autogenerate missing docs (#3514) 2021-05-30 12:57:04 +12:00
from-ics.md docs/commands: add from.md, update subcommands (#1712) 2020-05-05 09:01:31 +12:00
from-ini.md First pass at updating all documentation formatting and cleaning up output of examples (#2031) 2020-06-24 06:21:47 +12:00
from-json.md display boolean config options as true/false instead of Yes/No (#3043) 2021-02-11 21:50:33 +13:00
from-ods.md from xlsx/ods: Add parameter --sheets (#3600) 2021-06-10 07:44:24 -05:00
from-sqlite.md from sqlite: Add parameter --tables (#3529) 2021-06-01 17:06:32 -05:00
from-ssv.md Autogenerate missing docs (#3514) 2021-05-30 12:57:04 +12:00
from-toml.md First pass at updating all documentation formatting and cleaning up output of examples (#2031) 2020-06-24 06:21:47 +12:00
from-tsv.md First pass at updating all documentation formatting and cleaning up output of examples (#2031) 2020-06-24 06:21:47 +12:00
from-url.md First pass at updating all documentation formatting and cleaning up output of examples (#2031) 2020-06-24 06:21:47 +12:00
from-vcf.md First pass at updating all documentation formatting and cleaning up output of examples (#2031) 2020-06-24 06:21:47 +12:00
from-xlsx.md from xlsx/ods: Add parameter --sheets (#3600) 2021-06-10 07:44:24 -05:00
from-xml.md Fix typos (#2842) 2021-01-02 17:24:32 +13:00
from-yaml.md First pass at updating all documentation formatting and cleaning up output of examples (#2031) 2020-06-24 06:21:47 +12:00
from-yml.md Autogenerate missing docs (#3514) 2021-05-30 12:57:04 +12:00
from.md Update documentation to properly refer to subcommands with spaces (#2164) 2020-07-13 18:39:36 +12:00
get.md First pass at updating all documentation formatting and cleaning up output of examples (#2031) 2020-06-24 06:21:47 +12:00
group-by-date.md Autogenerate missing docs (#3514) 2021-05-30 12:57:04 +12:00
group-by.md Update documentation to properly refer to subcommands with spaces (#2164) 2020-07-13 18:39:36 +12:00
hash-base64.md Autogenerate missing docs (#3514) 2021-05-30 12:57:04 +12:00
hash-md5.md Autogenerate missing docs (#3514) 2021-05-30 12:57:04 +12:00
hash.md Autogenerate missing docs (#3514) 2021-05-30 12:57:04 +12:00
headers.md First pass at updating all documentation formatting and cleaning up output of examples (#2031) 2020-06-24 06:21:47 +12:00
help.md First pass at updating all documentation formatting and cleaning up output of examples (#2031) 2020-06-24 06:21:47 +12:00
histogram.md Bar Chart baseline. (#2621) 2020-09-30 13:27:52 -05:00
history.md Change f/full flag to l/long for ls and ps commands (#2283) 2020-08-02 06:30:45 +12:00
if.md Autogenerate missing docs (#3514) 2021-05-30 12:57:04 +12:00
inc.md First pass at updating all documentation formatting and cleaning up output of examples (#2031) 2020-06-24 06:21:47 +12:00
insert.md Fix whitespace and typos (#1481) 2020-03-14 06:23:41 +13:00
into-binary.md Autogenerate missing docs (#3514) 2021-05-30 12:57:04 +12:00
into-int.md Autogenerate missing docs (#3514) 2021-05-30 12:57:04 +12:00
into-string.md Autogenerate missing docs (#3514) 2021-05-30 12:57:04 +12:00
into.md Autogenerate missing docs (#3514) 2021-05-30 12:57:04 +12:00
keep-until.md Autogenerate missing docs (#3514) 2021-05-30 12:57:04 +12:00
keep-while.md Autogenerate missing docs (#3514) 2021-05-30 12:57:04 +12:00
keep.md Autogenerate missing docs (#3514) 2021-05-30 12:57:04 +12:00
kill.md Autogenerate missing docs (#3514) 2021-05-30 12:57:04 +12:00
last.md First pass at updating all documentation formatting and cleaning up output of examples (#2031) 2020-06-24 06:21:47 +12:00
length.md Rename count to length (#3166) 2021-03-14 10:46:40 +13:00
let-env.md Autogenerate missing docs (#3514) 2021-05-30 12:57:04 +12:00
let.md Autogenerate missing docs (#3514) 2021-05-30 12:57:04 +12:00
lines.md First pass at updating all documentation formatting and cleaning up output of examples (#2031) 2020-06-24 06:21:47 +12:00
load-env.md Autogenerate missing docs (#3514) 2021-05-30 12:57:04 +12:00
ls.md Autogenerate missing docs (#3514) 2021-05-30 12:57:04 +12:00
match.md Autogenerate missing docs (#3514) 2021-05-30 12:57:04 +12:00
math-abs.md Autogenerate missing docs (#3514) 2021-05-30 12:57:04 +12:00
math-avg.md Autogenerate missing docs (#3514) 2021-05-30 12:57:04 +12:00
math-ceil.md Autogenerate missing docs (#3514) 2021-05-30 12:57:04 +12:00
math-eval.md Make all bullet point items uppercase (#2257) 2020-07-26 06:15:12 +12:00
math-floor.md Autogenerate missing docs (#3514) 2021-05-30 12:57:04 +12:00
math-max.md Autogenerate missing docs (#3514) 2021-05-30 12:57:04 +12:00
math-median.md Autogenerate missing docs (#3514) 2021-05-30 12:57:04 +12:00
math-min.md Autogenerate missing docs (#3514) 2021-05-30 12:57:04 +12:00
math-mode.md Autogenerate missing docs (#3514) 2021-05-30 12:57:04 +12:00
math-product.md Autogenerate missing docs (#3514) 2021-05-30 12:57:04 +12:00
math-round.md Autogenerate missing docs (#3514) 2021-05-30 12:57:04 +12:00
math-sqrt.md Autogenerate missing docs (#3514) 2021-05-30 12:57:04 +12:00
math-stddev.md Autogenerate missing docs (#3514) 2021-05-30 12:57:04 +12:00
math-sum.md Autogenerate missing docs (#3514) 2021-05-30 12:57:04 +12:00
math-variance.md Autogenerate missing docs (#3514) 2021-05-30 12:57:04 +12:00
math.md Mathsqrt (#3239) 2021-04-01 16:26:05 -05:00
merge.md Autogenerate missing docs (#3514) 2021-05-30 12:57:04 +12:00
mkdir.md Autogenerate missing docs (#3514) 2021-05-30 12:57:04 +12:00
move.md Autogenerate missing docs (#3514) 2021-05-30 12:57:04 +12:00
mv.md Autogenerate missing docs (#3514) 2021-05-30 12:57:04 +12:00
n.md Autogenerate missing docs (#3514) 2021-05-30 12:57:04 +12:00
nth.md First pass at updating all documentation formatting and cleaning up output of examples (#2031) 2020-06-24 06:21:47 +12:00
open.md First pass at updating all documentation formatting and cleaning up output of examples (#2031) 2020-06-24 06:21:47 +12:00
p.md Autogenerate missing docs (#3514) 2021-05-30 12:57:04 +12:00
parse.md Autogenerate missing docs (#3514) 2021-05-30 12:57:04 +12:00
path-basename.md Autogenerate missing docs (#3514) 2021-05-30 12:57:04 +12:00
path-dirname.md Autogenerate missing docs (#3514) 2021-05-30 12:57:04 +12:00
path-exists.md Autogenerate missing docs (#3514) 2021-05-30 12:57:04 +12:00
path-expand.md Autogenerate missing docs (#3514) 2021-05-30 12:57:04 +12:00
path-join.md Autogenerate missing docs (#3514) 2021-05-30 12:57:04 +12:00
path-parse.md Autogenerate missing docs (#3514) 2021-05-30 12:57:04 +12:00
path-relative-to.md Autogenerate missing docs (#3514) 2021-05-30 12:57:04 +12:00
path-split.md Autogenerate missing docs (#3514) 2021-05-30 12:57:04 +12:00
path-type.md Autogenerate missing docs (#3514) 2021-05-30 12:57:04 +12:00
path.md Autogenerate missing docs (#3514) 2021-05-30 12:57:04 +12:00
pivot.md First pass at updating all documentation formatting and cleaning up output of examples (#2031) 2020-06-24 06:21:47 +12:00
post.md documentation: consistent abbreviation for URL (#3684) 2021-06-25 09:14:20 -05:00
prepend.md First pass at updating all documentation formatting and cleaning up output of examples (#2031) 2020-06-24 06:21:47 +12:00
ps.md Add cpu time to ps -l (#2507) 2020-09-07 17:02:45 +12:00
pwd.md Docs autoview pwd touch (#2068) 2020-06-28 14:22:26 +12:00
random-bool.md Autogenerate missing docs (#3514) 2021-05-30 12:57:04 +12:00
random-chars.md Autogenerate missing docs (#3514) 2021-05-30 12:57:04 +12:00
random-decimal.md Autogenerate missing docs (#3514) 2021-05-30 12:57:04 +12:00
random-dice.md Autogenerate missing docs (#3514) 2021-05-30 12:57:04 +12:00
random-integer.md Autogenerate missing docs (#3514) 2021-05-30 12:57:04 +12:00
random-uuid.md Autogenerate missing docs (#3514) 2021-05-30 12:57:04 +12:00
random.md Add random chars cmd (#2782) 2020-12-09 06:43:46 +13:00
range.md Autogenerate missing docs (#3514) 2021-05-30 12:57:04 +12:00
README.md First pass at updating all documentation formatting and cleaning up output of examples (#2031) 2020-06-24 06:21:47 +12:00
reduce.md Autogenerate missing docs (#3514) 2021-05-30 12:57:04 +12:00
reject.md First pass at updating all documentation formatting and cleaning up output of examples (#2031) 2020-06-24 06:21:47 +12:00
rename.md Split split command to sub commands. 2020-05-24 02:02:44 -05:00
reverse.md First pass at updating all documentation formatting and cleaning up output of examples (#2031) 2020-06-24 06:21:47 +12:00
rm.md Autogenerate missing docs (#3514) 2021-05-30 12:57:04 +12:00
roll-column.md Autogenerate missing docs (#3514) 2021-05-30 12:57:04 +12:00
roll-up.md Autogenerate missing docs (#3514) 2021-05-30 12:57:04 +12:00
roll.md Autogenerate missing docs (#3514) 2021-05-30 12:57:04 +12:00
rotate-counter-clockwise.md Autogenerate missing docs (#3514) 2021-05-30 12:57:04 +12:00
rotate.md Autogenerate missing docs (#3514) 2021-05-30 12:57:04 +12:00
s3.md Autogenerate missing docs (#3514) 2021-05-30 12:57:04 +12:00
save.md Update documentation to properly refer to subcommands with spaces (#2164) 2020-07-13 18:39:36 +12:00
select.md First pass at updating all documentation formatting and cleaning up output of examples (#2031) 2020-06-24 06:21:47 +12:00
selector.md Autogenerate missing docs (#3514) 2021-05-30 12:57:04 +12:00
seq-date.md Autogenerate missing docs (#3514) 2021-05-30 12:57:04 +12:00
seq.md Autogenerate missing docs (#3514) 2021-05-30 12:57:04 +12:00
shells.md First pass at updating all documentation formatting and cleaning up output of examples (#2031) 2020-06-24 06:21:47 +12:00
shuffle.md First pass at updating all documentation formatting and cleaning up output of examples (#2031) 2020-06-24 06:21:47 +12:00
size.md Size command: rename max length to bytes (#2473) 2020-09-01 14:51:35 +12:00
skip-until.md Autogenerate missing docs (#3514) 2021-05-30 12:57:04 +12:00
skip-while.md First pass at updating all documentation formatting and cleaning up output of examples (#2031) 2020-06-24 06:21:47 +12:00
skip.md First pass at updating all documentation formatting and cleaning up output of examples (#2031) 2020-06-24 06:21:47 +12:00
sleep.md Sleep command (#2381) 2020-08-22 05:51:29 +12:00
sort-by.md Add flag for case-insensitive sort-by (#2225) 2020-07-21 05:31:58 +12:00
source.md Autogenerate missing docs (#3514) 2021-05-30 12:57:04 +12:00
split-by.md Autogenerate missing docs (#3514) 2021-05-30 12:57:04 +12:00
split-chars.md Autogenerate missing docs (#3514) 2021-05-30 12:57:04 +12:00
split-column.md Auto-Generate Documentation for nushell.com (#2139) 2020-07-18 10:22:43 +12:00
split-row.md Auto-Generate Documentation for nushell.com (#2139) 2020-07-18 10:22:43 +12:00
split.md Autogenerate missing docs (#3514) 2021-05-30 12:57:04 +12:00
start.md First pass at updating all documentation formatting and cleaning up output of examples (#2031) 2020-06-24 06:21:47 +12:00
str-camel-case.md Autogenerate missing docs (#3514) 2021-05-30 12:57:04 +12:00
str-capitalize.md Autogenerate missing docs (#3514) 2021-05-30 12:57:04 +12:00
str-collect.md Autogenerate missing docs (#3514) 2021-05-30 12:57:04 +12:00
str-contains.md Autogenerate missing docs (#3514) 2021-05-30 12:57:04 +12:00
str-downcase.md Autogenerate missing docs (#3514) 2021-05-30 12:57:04 +12:00
str-ends-with.md Autogenerate missing docs (#3514) 2021-05-30 12:57:04 +12:00
str-find-replace.md Autogenerate missing docs (#3514) 2021-05-30 12:57:04 +12:00
str-index-of.md Autogenerate missing docs (#3514) 2021-05-30 12:57:04 +12:00
str-kebab-case.md Autogenerate missing docs (#3514) 2021-05-30 12:57:04 +12:00
str-length.md Autogenerate missing docs (#3514) 2021-05-30 12:57:04 +12:00
str-lpad.md Autogenerate missing docs (#3514) 2021-05-30 12:57:04 +12:00
str-ltrim.md Autogenerate missing docs (#3514) 2021-05-30 12:57:04 +12:00
str-pascal-case.md Autogenerate missing docs (#3514) 2021-05-30 12:57:04 +12:00
str-reverse.md Autogenerate missing docs (#3514) 2021-05-30 12:57:04 +12:00
str-rpad.md Autogenerate missing docs (#3514) 2021-05-30 12:57:04 +12:00
str-rtrim.md Autogenerate missing docs (#3514) 2021-05-30 12:57:04 +12:00
str-screaming-snake-case.md Autogenerate missing docs (#3514) 2021-05-30 12:57:04 +12:00
str-snake-case.md Autogenerate missing docs (#3514) 2021-05-30 12:57:04 +12:00
str-starts-with.md Autogenerate missing docs (#3514) 2021-05-30 12:57:04 +12:00
str-substring.md Autogenerate missing docs (#3514) 2021-05-30 12:57:04 +12:00
str-to-datetime.md Autogenerate missing docs (#3514) 2021-05-30 12:57:04 +12:00
str-to-decimal.md Autogenerate missing docs (#3514) 2021-05-30 12:57:04 +12:00
str-to-int.md Autogenerate missing docs (#3514) 2021-05-30 12:57:04 +12:00
str-trim.md Autogenerate missing docs (#3514) 2021-05-30 12:57:04 +12:00
str-upcase.md Autogenerate missing docs (#3514) 2021-05-30 12:57:04 +12:00
str.md Add str reverse subcommand (#2170) 2020-07-15 08:47:04 +12:00
sys.md First pass at updating all documentation formatting and cleaning up output of examples (#2031) 2020-06-24 06:21:47 +12:00
table.md Autogenerate missing docs (#3514) 2021-05-30 12:57:04 +12:00
tags.md First pass at updating all documentation formatting and cleaning up output of examples (#2031) 2020-06-24 06:21:47 +12:00
textview_config.md Fix typos and capitalization of "Unicode" (#3234) 2021-04-04 07:14:07 +12:00
textview.md Autogenerate missing docs (#3514) 2021-05-30 12:57:04 +12:00
to-bson.md Autogenerate missing docs (#3514) 2021-05-30 12:57:04 +12:00
to-csv.md Update documentation to properly refer to subcommands with spaces (#2164) 2020-07-13 18:39:36 +12:00
to-html.md Autogenerate missing docs (#3514) 2021-05-30 12:57:04 +12:00
to-json.md First pass at updating all documentation formatting and cleaning up output of examples (#2031) 2020-06-24 06:21:47 +12:00
to-md.md Add pretty flag to to md (#2640) 2020-10-15 16:20:55 +13:00
to-sqlite.md to sqlite: Fix panic caused by empty tables (#3522) 2021-05-31 21:46:07 +12:00
to-toml.md Bump to 0.33.1 (#3671) 2021-06-23 19:57:41 +12:00
to-tsv.md First pass at updating all documentation formatting and cleaning up output of examples (#2031) 2020-06-24 06:21:47 +12:00
to-url.md First pass at updating all documentation formatting and cleaning up output of examples (#2031) 2020-06-24 06:21:47 +12:00
to-xml.md to-xml.md documentation update (#2253) 2020-07-25 20:19:15 +12:00
to-yaml.md First pass at updating all documentation formatting and cleaning up output of examples (#2031) 2020-06-24 06:21:47 +12:00
to.md Add pretty flag to to md (#2640) 2020-10-15 16:20:55 +13:00
touch.md Fix typos (#2842) 2021-01-02 17:24:32 +13:00
tree.md Autogenerate missing docs (#3514) 2021-05-30 12:57:04 +12:00
uniq.md First pass at updating all documentation formatting and cleaning up output of examples (#2031) 2020-06-24 06:21:47 +12:00
update.md Add examples to update cmd (#2628) 2020-10-01 20:13:42 -05:00
url-host.md Autogenerate missing docs (#3514) 2021-05-30 12:57:04 +12:00
url-path.md Autogenerate missing docs (#3514) 2021-05-30 12:57:04 +12:00
url-query.md Autogenerate missing docs (#3514) 2021-05-30 12:57:04 +12:00
url-scheme.md Autogenerate missing docs (#3514) 2021-05-30 12:57:04 +12:00
url.md Autogenerate missing docs (#3514) 2021-05-30 12:57:04 +12:00
version.md First pass at updating all documentation formatting and cleaning up output of examples (#2031) 2020-06-24 06:21:47 +12:00
where.md Fix duration literals in where docs (#3573) 2021-06-07 15:21:31 -05:00
which.md display boolean config options as true/false instead of Yes/No (#3043) 2021-02-11 21:50:33 +13:00
with-env.md Autogenerate missing docs (#3514) 2021-05-30 12:57:04 +12:00
wrap.md First pass at updating all documentation formatting and cleaning up output of examples (#2031) 2020-06-24 06:21:47 +12:00
xpath.md Autogenerate missing docs (#3514) 2021-05-30 12:57:04 +12: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.