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
Fabian Homborg
4c656dd43e
docs/fish_git_prompt: showupstream is a proper list
...
"space-delimited" sounds like you'd set it like `set
__fish_git_prompt_showupstream "auto verbose"`. This will not work.
It's a real actual proper list, which aren't space-delimited.
[ci skip]
2019-08-23 19:35:39 +02:00
LawAbidingCactus
1a361cd3ff
specify that __fish_git_prompt_describe_style only takes one argument
2019-08-23 10:25:58 -07:00
LawAbidingCactus
ea041e6668
specify that __fish_git_prompt_showupstream takes multiple arguments
2019-08-23 10:25:58 -07:00
LawAbidingCactus
b0e9317dd2
document auto option for __fish_git_prompt_showupstream
2019-08-23 10:25:58 -07:00
Fabian Homborg
427a18c1ea
fish_git_prompt: Add a way to use the informative chars
...
$__fish_git_prompt_use_informative_chars will use the informative
chars without requiring informative mode (which is really frickin'
slow!).
See #5726 .
[ci skip]
2019-06-25 16:11:18 +02:00
David Adam
87518a524f
docs: update the VCS prompt function documentation
...
Edited for clarity and formatting.
[ci skip]
2019-04-11 23:51:47 +08: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
191b74df6f
docs: Fix some sphinx errors
...
See #5696 .
[ci skip]
2019-03-29 20:55:28 +01:00
Fabian Homborg
6cf61d5235
docs/fish_git_prompt: Fix formatting
...
Sphinx likes empty lines before lists.
Also give variable names the ``treatment``.
[ci skip]
2019-03-28 22:11:28 +01:00
Fabian Homborg
c94fe0f8c9
docs/fish_git_prompt: Document default settings
...
This should help with interpreting the results.
All this is quite convoluted, especially with defaults dependent on
other settings.
[ci skip]
2019-03-28 21:16:05 +01:00
Fabian Homborg
f8b88d5b98
docs/fish_git_prompt: Better document variables
...
More accurate, also the code example can now be copy-pasted.
[ci skip]
2019-03-19 21:07:49 +01:00
ridiculousfish
6cd8856484
Add the vcs prompts to sphinx docs
2019-02-24 18:21:36 -08:00
