Skip to content

Commit

Permalink
Minor markup and copy+paste fixes (#7)
Browse files Browse the repository at this point in the history
  • Loading branch information
kannibalox authored and pyroscope committed Feb 17, 2018
1 parent 0383382 commit ec81087
Show file tree
Hide file tree
Showing 3 changed files with 14 additions and 17 deletions.
19 changes: 8 additions & 11 deletions docs/include-cmd-items.rst
Original file line number Diff line number Diff line change
Expand Up @@ -311,7 +311,7 @@ When called within configuration methods or in a ``Ctrl-X`` prompt, the target i

.. code-block:: ini
d.disconnect.seeders = ‹hash› ≫ value ‹rate›
d.disconnect.seeders = ‹hash› ≫ 0
Cleanly drop all connections to seeders. This does not prevent them from
reconnecting later on.
Expand Down Expand Up @@ -575,7 +575,6 @@ When called within configuration methods or in a ``Ctrl-X`` prompt, the target i
d.size_files = ‹hash› ≫ value ‹files›
d.size_pex = ‹hash› ≫ value ‹peers›
Skipped pieces are ones that were received from peers, but weren't needed and thus ignored.
Returns the various size attributes of an item.

- **bytes**: The total number of bytes in the item's files.
Expand Down Expand Up @@ -762,7 +761,7 @@ Index counting starts at ``0``, the array size is :term:`d.size_files`.
f.completed_chunks = ‹infohash› ≫ value ‹chunks›
The number of chunks in the file completed. Just as with term:`f.size_chunks`, this number is
The number of chunks in the file completed. Just as with :term:`f.size_chunks`, this number is
inclusive of any chunks that contain only part of the file.

f.frozen_path
Expand Down Expand Up @@ -793,12 +792,10 @@ Index counting starts at ``0``, the array size is :term:`d.size_files`.
f.last_touched = ‹infohash› ≫ value ‹microseconds›
The last time, in `epoch`_ microseconds, *rTorrent* prepared to use the file
The last time, in `epoch <https://en.wikipedia.org/wiki/Unix_time>`_ microseconds, *rTorrent* prepared to use the file
(for either reading or writing). This will not necessarily correspond to the file's
access or modification times.

.. _`epoch`: https://en.wikipedia.org/wiki/Unix_time

f.match_depth_next
f.match_depth_prev

Expand All @@ -811,7 +808,7 @@ Index counting starts at ``0``, the array size is :term:`d.size_files`.
f.offset = ‹infohash› ≫ value ‹bytes›
The offset (in bytes) of the file from the start of the torrent data. The first file starts at ``0``, the second file
at term:`f.size_bytes` of the first file, the third at term:`f.size_bytes` of the first two files combined, and so on.
at :term:`f.size_bytes` of the first file, the third at :term:`f.size_bytes` of the first two files combined, and so on.

f.path

Expand Down Expand Up @@ -895,7 +892,7 @@ Index counting starts at ``0``, the array size is :term:`d.size_files`.
Returns the number of bytes and chunks in the file respectively. If the file is only partially in some chunks,
those are included in the count. This means the sum of all ``f.size_chunks`` can be
larger than :term:`d.size_chunks`
larger than :term:`d.size_chunks`.


.. _p-commands:
Expand Down Expand Up @@ -1039,9 +1036,9 @@ Example:

.. code-block:: ini
p.is_obfuscated = ‹target› ≫ bool (0 or 1)
p.is_incoming = ‹target› ≫ bool (0 or 1)
Return true if the remote peer was the first one to initiate the connection. See :term:`protocol.encryption.set`.
Return true if the remote peer was the first one to initiate the connection.

p.is_obfuscated

Expand Down Expand Up @@ -1236,7 +1233,7 @@ and using ``Ctrl-K`` also implicitly unties an item.
session.name.set = string ‹name› ≫ 0
This controls the session name. By default this is set to :term:`system.hostname` + ':' +
term:`system.pid`. Like term:`session.path`, once the session is active this cannot
:term:`system.pid`. Like :term:`session.path`, once the session is active this cannot
be changed


Expand Down
4 changes: 2 additions & 2 deletions docs/include-cmd-network.rst
Original file line number Diff line number Diff line change
Expand Up @@ -139,8 +139,8 @@

.. code-block:: ini
network.scgi.open_local = ‹path› ≫ 0
network.scgi.open_port = ‹domain_or_ip›:‹port› ≫ 0
network.scgi.open_local = string ‹path› ≫ 0
network.scgi.open_port = string ‹domain_or_ip›:‹port› ≫ 0
Open up a Unix domain socket or a TCP port for SCGI communication (i.e. the XMLRPC socket).
Only use *one* of these!
Expand Down
8 changes: 4 additions & 4 deletions docs/include-cmd-system.rst
Original file line number Diff line number Diff line change
Expand Up @@ -284,11 +284,11 @@ Commands related to the operating system and the XMLRPC API.
system.time_seconds ≫ value ‹time›
system.time_usec ≫ value ‹time›
Returns the system times in `epoch`_ notation. ``system.time_usec`` returns the value
in microseconds instead of seconds. ``system.time`` is essentially an alias for
``system.time_seconds``.
Returns the system times in `epoch <https://en.wikipedia.org/wiki/Unix_time>`_ notation.
``system.time_usec`` returns the value in microseconds instead of seconds.
``system.time`` is essentially an alias for ``system.time_seconds``.

**TODO:** Is there any practical difference when using the cached ``system.time``?
**TODO** Is there any practical difference when using the cached ``system.time``?

system.umask.set

Expand Down

0 comments on commit ec81087

Please sign in to comment.