h/fish-shell
1
Fork 0
mirror of https://github.com/fish-shell/fish-shell.git synced 2026-04-27 14:51:14 -03:00
Code Issues Packages Projects Releases Wiki Activity

docs: Use command labels

Browse Source 
[ci skip]
This commit is contained in:
Fabian Homborg
2019-03-31 11:07:59 +02:00
parent cf9b8fa3fa
commit cb94dd4d30
11 changed files with 20 additions and 20 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
sphinx_doc_src/cmds/function.rst
View File

@@ -22,7 +22,7 @@ The following options are available:
- ``-d DESCRIPTION`` or ``--description=DESCRIPTION`` is a description of what the function does, suitable as a completion description.
- ``-w WRAPPED_COMMAND`` or ``--wraps=WRAPPED_COMMAND`` causes the function to inherit completions from the given wrapped command. See the documentation for `complete <cmds/complete.html>`__ for more information.
- ``-w WRAPPED_COMMAND`` or ``--wraps=WRAPPED_COMMAND`` causes the function to inherit completions from the given wrapped command. See the documentation for :ref:`complete <cmd-complete>` for more information.
- ``-e`` or ``--on-event EVENT_NAME`` tells fish to run this function when the specified named event is emitted. Fish internally generates named events e.g. when showing the prompt.
@@ -43,7 +43,7 @@ The following options are available:
If the user enters any additional arguments after the function, they are inserted into the environment `variable array <index.html#variables-arrays>`__ ``$argv``. If the ``--argument-names`` option is provided, the arguments are also assigned to names specified in that option.
By using one of the event handler switches, a function can be made to run automatically at specific events. The user may generate new events using the `emit <cmds/emit.html>`__ builtin. Fish generates the following named events:
By using one of the event handler switches, a function can be made to run automatically at specific events. The user may generate new events using the :ref:`emit <cmd-emit>` builtin. Fish generates the following named events:
- ``fish_prompt``, which is emitted whenever a new fish prompt is about to be displayed.