[nongnu] elpa/hyperdrive afbd73f547 6/7: Docs: Improve documentation for Non-interactive Use section

[ELPA Syncer]

branch: elpa/hyperdrive
commit afbd73f5471ec0242b96d866bbd7af8bfd839687
Author: Joseph Turner <joseph@ushin.org>
Commit: Joseph Turner <joseph@ushin.org>

    Docs: Improve documentation for Non-interactive Use section
---
 doc/hyperdrive.org  | 13 ++++++++-----
 doc/hyperdrive.texi | 12 +++++++-----
 2 files changed, 15 insertions(+), 10 deletions(-)

diff --git a/doc/hyperdrive.org b/doc/hyperdrive.org
index c5fbd7ea42..2e2760dfef 100644
--- a/doc/hyperdrive.org
+++ b/doc/hyperdrive.org
@@ -698,14 +698,17 @@ recoverable.*
   and ~hyperdrive-version-ranges~ variables.
 
 ** Non-interactive use
-#+findex: hyperdrive-by-slot
 
 In writing your own functions to extend ~hyperdrive.el~, you can use
-~hyperdrive-by-slot~ to access a hyperdrive by its seed, petname, or
-public key.
+~hyperdrive-by-slot~ to access a hyperdrive by its metadata:
+
+- Function: hyperdrive-by-slot ::
+
+  This function accepts a hyperdrive seed, petname, or public key, and
+  returns the hyperdrive ~struct~.
 
-For examples, see [[*Mirror a whole directory]] and [[*Mirror files by tag or
-other attributes]].
+For example usage, see [[*Mirror a whole directory]] and [[*Mirror files by
+tag or other attributes]].
 
 ** Miscellaneous features
 
diff --git a/doc/hyperdrive.texi b/doc/hyperdrive.texi
index b3fd6ad33e..dd6812d885 100644
--- a/doc/hyperdrive.texi
+++ b/doc/hyperdrive.texi
@@ -996,13 +996,15 @@ and @code{hyperdrive-version-ranges} variables.
 @node Non-interactive use
 @section Non-interactive use
 
-@findex hyperdrive-by-slot
-
 In writing your own functions to extend @code{hyperdrive.el}, you can use
-@code{hyperdrive-by-slot} to access a hyperdrive by its seed, petname, or
-public key.
+@code{hyperdrive-by-slot} to access a hyperdrive by its metadata:
+
+@defun hyperdrive-by-slot
+This function accepts a hyperdrive seed, petname, or public key, and
+returns the hyperdrive @code{struct}.
+@end defun
 
-For examples, see @ref{Mirror a whole directory} and @ref{Mirror files by tag 
or other attributes}.
+For example usage, see @ref{Mirror a whole directory} and @ref{Mirror files by 
tag or other attributes}.
 
 @node Miscellaneous features
 @section Miscellaneous features