[nongnu] elpa/hyperdrive 383c1c606e 17/32: Docs: Document hyperdrive-dir-sort

[ELPA Syncer]

branch: elpa/hyperdrive
commit 383c1c606efb0ac6ddac17015079b2c70e5bf751
Author: Joseph Turner <joseph@ushin.org>
Commit: Adam Porter <adam@alphapapa.net>

    Docs: Document hyperdrive-dir-sort
---
 doc/hyperdrive-manual.org | 9 +++++++++
 hyperdrive-dir.el         | 1 -
 2 files changed, 9 insertions(+), 1 deletion(-)

diff --git a/doc/hyperdrive-manual.org b/doc/hyperdrive-manual.org
index 20ceb051a7..29aa212d38 100644
--- a/doc/hyperdrive-manual.org
+++ b/doc/hyperdrive-manual.org
@@ -171,6 +171,8 @@ default:
 - ~^~ goes up to the parent directory
 #+kindex: revert-buffer
 - ~g~ refreshes the directory to display potential updates
+#+kindex: hyperdrive-dir-sort
+- ~o~ sorts directory contents by column
 #+kindex: hyperdrive-dir-download-file
 - ~d~ downloads the file at point to disk
 #+kindex: hyperdrive-dir-delete
@@ -464,6 +466,13 @@ customize-group RET hyperdrive RET~:
 - ~hyperdrive-directory-display-buffer-action~ :: Display buffer action
   for hyperdrive directories. Passed to ~display-buffer~, which see.
 
+#+vindex: hyperdrive-directory-sort
+- ~hyperdrive-directory-sort~ :: Column by which directory entries are
+  sorted.  Internally, a cons cell of (KEY . PREDICATE), the KEY being
+  the `hyperdrive-entry' accessor function and the PREDICATE being the
+  appropriate function (e.g. `time-less-p' for
+  `hyperdrive-entry-modified', `<' for `hyperdrive-entry-size', etc).
+
 #+vindex: hyperdrive-column-headers
 - ~hyperdrive-column-headers~ :: Display column headers in
   ~hyperdrive-dir~ and ~hyperdrive-history~ buffers. Defaults to ~t~.
diff --git a/hyperdrive-dir.el b/hyperdrive-dir.el
index 61cce7e146..25813dff41 100644
--- a/hyperdrive-dir.el
+++ b/hyperdrive-dir.el
@@ -175,7 +175,6 @@ Interactively, visit file or directory at point in
   (hyperdrive-history entry))
 
 (defun hyperdrive-dir-sort (directory-sort)
-  ;; TODO(doc): hyperdrive-dir-sort.
   "Sort current `hyperdrive-dir' buffer by DIRECTORY-SORT.
 DIRECTORY-SORT should be a valid value of
 `hyperdrive-directory-sort'."