add issue about ordering

1 files changed, 21 insertions, 0 deletions

diff --git a/app/Main.hs b/app/Main.hs
index 1540178..2ca20da 100644
--- a/app/Main.hs
+++ b/app/Main.hs
@@ -240,6 +240,27 @@
 -- Running `anissue show tool-crashes-when-displaying-unicode-emojis`
 -- will crash because of 🏗️.
 
+-- TODO Add options to specify ordering of issues
+--
+-- When running `anissue list` with the `--order-by` option, the list
+-- should be ordered accordingly.  Possible values could be
+--
+-- creation
+-- : the time when the issue was created
+--
+-- update
+-- : the time when the issue was updated last
+--
+-- title
+-- : lexicographically by title
+--
+-- priority
+-- : by priority
+--
+-- Additionally using `--reversed`, the order will be reversed.
+--
+-- @topic options
+
 module Main where
 
 import Data.List (find)