Skip to content

Commit

Permalink
cmd-ref: link event.download.finished_delayed to its 'use-cases' section
Browse files Browse the repository at this point in the history
  • Loading branch information
pyroscope committed Jun 1, 2018
1 parent 2ac0801 commit f312370
Show file tree
Hide file tree
Showing 2 changed files with 15 additions and 7 deletions.
20 changes: 14 additions & 6 deletions docs/cmd-ref.rst
Original file line number Diff line number Diff line change
Expand Up @@ -217,6 +217,20 @@ The following sections explain some core commands added by well-known configurat
If you want other setups (`rtinst`, `QuickBox`, …) to be documented, we accept pull requests.


Examples in This Manual
^^^^^^^^^^^^^^^^^^^^^^^

These commands are from snippets presented in other chapters.

.. glossary::

event.download.finished_delayed
event.download.finished_delayed.interval
event.download.finished_delayed.interval.set

See :ref:`event.download.finished_delayed` for a full explanation.


`rTorrent` Wiki Template
^^^^^^^^^^^^^^^^^^^^^^^^

Expand Down Expand Up @@ -318,12 +332,6 @@ In addition to the commands listed here, `pyrocore` also defines :term:`d.data_p

**TODO**

event.download.finished_delayed
event.download.finished_delayed.interval
event.download.finished_delayed.interval.set

**TODO**

quit

**TODO**
Expand Down
2 changes: 1 addition & 1 deletion docs/use-cases.rst
Original file line number Diff line number Diff line change
Expand Up @@ -256,7 +256,7 @@ Then add a rule like this to the body of ``set_target_path``:
Delayed Completion Handling
---------------------------

The following config snippet defines a new ``event.download.finished_delayed`` trigger
The following config snippet defines a new :term:`event.download.finished_delayed` trigger
that works like the normal finished event, but only fires after a customizable delay.

One use-case for such a thing is to move a download from fast storage (RAM disk, SSD)
Expand Down

0 comments on commit f312370

Please sign in to comment.