David Adam
02d82dcf85
docs: update all command synopsis formatting
...
Adds synopses for those commands missing them.
Moves all synopsis sections to code blocks. This improves the appearance, although highlighting as
fish code may not be the ideal appearance.
2019-09-17 17:59:04 +08:00
David Adam
4265b02eb3
docs: standardise on exit status terminology
...
Exit status is used in the POSIX specification and is preferred over return code/return status/exit
code.
[ci skip]
2019-09-17 16:37:01 +08:00
Fabian Homborg
8c9359fdd4
src/builtin_argparse: Add --ignore-unknown flag
...
This keeps all unknown options in $argv, so
```fish
argparse -i a/alpha -- -a banana -o val -w
```
results in $_flag_a set to banana, and $argv set to `-o val -w`.
This allows users to use multiple argparse passes, or to simply avoid
specifying all options e.g. in completions - `systemctl` has 46 of
them, most not having any effect on the completions.
Fixes #5367 .
2019-04-29 15:57:56 +02:00
Fabian Homborg
af0e08e9f1
argparse: Use the current function name by default
...
This makes the `--name` option usually unnecessary.
See #5835 .
2019-04-27 15:55:49 +02:00
Fabian Homborg
eb0e0a4ab4
docs/argparse: Fix links
...
Fixes #5847 .
[ci skip]
2019-04-27 12:16:53 +02:00
Fabian Homborg
cb94dd4d30
docs: Use command labels
...
[ci skip]
2019-03-31 11:15:57 +02:00
Fabian Homborg
cf9b8fa3fa
docs: Add labels to all commands
...
This allows us to use :ref: references, which don't require hardcoding
it as html
[ci skip]
2019-03-31 11:05:33 +02:00
Fabian Homborg
0c4580d874
docs: Fix moar reference syntax
2019-03-30 20:44:07 +01:00
ridiculousfish
c8dc306b18
Fix command section separator line lengths
2019-02-24 18:15:48 -08:00
ridiculousfish
0e936198db
Switch backticks to double backticks for rst compatibility
2019-02-24 18:15:48 -08:00
ridiculousfish
2a002a4ba1
Switch \fish sections to rst format
2019-02-24 18:15:48 -08:00
ridiculousfish
c33d1a217c
Convert \\subsection sections into rst format
2019-02-24 18:15:48 -08:00
ridiculousfish
256c2dadee
Migrate the 'synopsis' sections to .rst format
2019-02-24 18:15:48 -08:00
ridiculousfish
c213882511
Switch command docs from \section to reStructuredText
2019-02-24 18:15:48 -08:00
ridiculousfish
afd035f8cc
Copy doc_src to sphinx_doc_src and add a TOC
2019-02-24 18:15:48 -08:00
