github-mirror/fish-shell
github-mirror/fish-shell
2
0
Fork 0
mirror of https://github.com/fish-shell/fish-shell.git synced 2025-02-22 15:16:24 +08:00
Code Issues Actions Packages Projects Releases Wiki Activity

docs: Format path synopsis

Browse Source 
This was written while we changed how our synopses are formatted, so
we missed adding a "synopsis" marker to it.

The tokenizer here is a bit cheesy, so we can't mark continuation
lines with a "\", and we also can't mark the general options with a
":=". Tbh that's not a big deal.

Fixes #9154
This commit is contained in:
Fabian Boehm 2022-08-25 13:06:57 +02:00
parent 6581362e1e
commit c753f22003
1 changed files with 4 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
doc_src/cmds/path.rst
View File

@ -6,13 +6,13 @@ path - manipulate and check paths
Synopsis Synopsis
-------- --------
:: .. synopsis::
path basename GENERAL_OPTIONS [PATH ...] path basename GENERAL_OPTIONS [PATH ...]
path dirname GENERAL_OPTIONS [PATH ...] path dirname GENERAL_OPTIONS [PATH ...]
path extension GENERAL_OPTIONS [PATH ...] path extension GENERAL_OPTIONS [PATH ...]
path filter GENERAL_OPTIONS [-v | --invert] path filter GENERAL_OPTIONS [-v | --invert]
[-d] [-f] [-l] [-r] [-w] [-x] \ [-d] [-f] [-l] [-r] [-w] [-x]
[(-t | --type) TYPE] [(-p | --perm) PERMISSION] [PATH ...] [(-t | --type) TYPE] [(-p | --perm) PERMISSION] [PATH ...]
path is GENERAL_OPTIONS [(-v | --invert)] [(-t | --type) TYPE] path is GENERAL_OPTIONS [(-v | --invert)] [(-t | --type) TYPE]
[-d] [-f] [-l] [-r] [-w] [-x] [-d] [-f] [-l] [-r] [-w] [-x]
@ -24,7 +24,8 @@ Synopsis
path sort GENERAL_OPTIONS [-r | --reverse] path sort GENERAL_OPTIONS [-r | --reverse]
[-u | --unique] [--key=basename|dirname|path] [PATH ...] [-u | --unique] [--key=basename|dirname|path] [PATH ...]
GENERAL_OPTIONS := [-z | --null-in] [-Z | --null-out] [-q | --quiet] GENERAL_OPTIONS
[-z | --null-in] [-Z | --null-out] [-q | --quiet]
Description Description
----------- -----------