More documentation work

This commit is contained in:
Aaron Gyes
2021-12-09 03:53:13 -08:00
parent 79d1b3e085
commit 3b629d29aa
6 changed files with 41 additions and 46 deletions

View File

@@ -6,9 +6,7 @@ block - temporarily block delivery of events
Synopsis
--------
::
block [OPTIONS...]
``block`` [*OPTIONS* ...]
Description
@@ -24,16 +22,17 @@ Event blocks should not be confused with code blocks, which are created with ``b
The following parameters are available:
- ``-l`` or ``--local`` Release the block automatically at the end of the current innermost code block scope
**-l** or **--local**
Release the block automatically at the end of the current innermost code block scope
- ``-g`` or ``--global`` Never automatically release the lock
- ``-e`` or ``--erase`` Release global block
**-g** or **--global**
Never automatically release the lock
**-e** or **--erase**
Release global block
Example
-------
::
# Create a function that listens for events
@@ -48,8 +47,7 @@ Example
block -e
# 'foo fired' will now be printed
Notes
-----
Note that events are only received from the current fish process as there is no way to send events from one fish process to another.
Events are only received from the current fish process as there is no way to send events from one fish process to another (yet).