From 429c31363445bd8237eb0e99b64e21a8b9da11f7 Mon Sep 17 00:00:00 2001 From: Adam Porter Date: Fri, 16 Aug 2019 12:27:30 -0500 Subject: [PATCH] Docs: Organize commands --- README.org | 19 +++++++++++++++---- 1 file changed, 15 insertions(+), 4 deletions(-) diff --git a/README.org b/README.org index f570303..f6044eb 100644 --- a/README.org +++ b/README.org @@ -111,13 +111,24 @@ Installing with [[https://framagit.org/steckerhalter/quelpa][Quelpa]] is easy: The functionality provided may be grouped by: -+ Interactive commands :: ~org-ql-search~ -+ Non-interactive functions and macros :: ~org-ql~ (macro), ~org-ql-select~ (function), ~org-ql-query~ (function), ~org-ql-block~ (agenda function), and ~org-ql-agenda~ (macro) ++ *Interactive commands:* ~org-ql-search~, ~org-ql-view~. ++ *Non-interactive functions and macros:* + - ~org-ql~ (macro) + - ~org-ql-select~ (function) + - ~org-ql-query~ (function) + - ~org-ql-agenda~ (macro) + - ~org-ql-block~ (agenda function) Alternatively, they may be grouped by: -+ Showing an agenda-like view :: ~org-ql-search~ (command), ~org-ql-block~ (agenda function), and ~org-ql-agenda~ (macro) -+ Returning a list of matches or acting on them :: ~org-ql~ (macro), ~org-ql-select~ (function), and ~org-ql-query~ (function) ++ *Showing an agenda-like view:* + - ~org-ql-search~ (command) + - ~org-ql-block~ (agenda function) + - ~org-ql-agenda~ (macro) ++ *Returning a list of matches or acting on them:* + - ~org-ql~ (macro) + - ~org-ql-select~ (function) + - ~org-ql-query~ (function) Feedback on these APIs is welcome. Eventually, after being tested and polished, they will be considered stable.