[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[nongnu] elpa/geiser-stklos 0e3a057 28/30: Enhance documentation in Comm
From: |
Philip Kaludercic |
Subject: |
[nongnu] elpa/geiser-stklos 0e3a057 28/30: Enhance documentation in Commentary section |
Date: |
Sun, 1 Aug 2021 18:32:45 -0400 (EDT) |
branch: elpa/geiser-stklos
commit 0e3a0570354c03c0cfa25da82fb34ad2e81c1981
Author: Jeronimo Pellegrini <j_p@aleph0.info>
Commit: Jeronimo Pellegrini <j_p@aleph0.info>
Enhance documentation in Commentary section
---
geiser-stklos.el | 52 ++++++++++++++++++++++++++++++++++++++++++++++++++--
1 file changed, 50 insertions(+), 2 deletions(-)
diff --git a/geiser-stklos.el b/geiser-stklos.el
index d822b60..ed78fa6 100644
--- a/geiser-stklos.el
+++ b/geiser-stklos.el
@@ -16,8 +16,56 @@
;;; Commentary:
-
-;; geiser-stklos adds STklos Scheme support to the `geiser' package
+;;
+;; Geiser, STklos and Geisr-STklos
+;; ───────────────────────────────
+;;
+;; Geiser (https://www.nongnu.org/geiser/) is a collection of Emacs
+;; major and minor modes for Scheme development.
+;;
+;; STklos (http://stklos.net) is a free Scheme system mostly compliant
+;; with the languages features defined in R7RS small. The aim of this
+;; implementation is to be fast as well as light. The implementation is
+;; based on an ad-hoc Virtual Machine. STklos can also be compiled as a
+;; library and embedded in an application.
+;;
+;; Geiser-Stklos adds STklos Scheme support to the Geiser package.
+;;
+;; Supported Geiser features
+;; ─────────────────────────
+;;
+;; * evaluation of sexps, definitions, regions and whole buffers
+;; * loading Scheme files
+;; * adding paths to `load-path`
+;; * macroexpansion
+;; * symbol completion
+;; * listing of module exported symbols
+;; * autodoc (signature of procedurs and values of symbols are displayed in
the minibuffer
+;; when the mouse hovers over their names)
+;; * symbol documentation (docstrings for procedures, and values of variables)
+;;
+;; Unsupported Geiser features
+;; ───────────────────────────
+;;
+;; * finding the definition of a symbol (no support in STklos)
+;; * seeing callees and callers of a procedure (no support in STklos)
+;; * looking up symbols in the manual (would need to download the index from
STklos manual and parse the DOM of its index; a bit too much, maybe someday...)
+;;
+;; Usage
+;; ─────
+;;
+;; Please consult the Geiser manual at https://www.nongnu.org/geiser/
+;;
+;; Notes
+;; ─────
+;;
+;; * Squarify (alternating between "[" and "(" ) only works when the cursor is
inside a form
+;;
+;; Bugs
+;; ────
+;;
+;; See the Gitlab issue tracker at
https://gitlab.com/emacs-geiser/stklos/-/issues
+;;
- [nongnu] elpa/geiser-stklos 6228b23 21/30: Corectly require Geiser core, (continued)
- [nongnu] elpa/geiser-stklos 6228b23 21/30: Corectly require Geiser core, Philip Kaludercic, 2021/08/01
- [nongnu] elpa/geiser-stklos a02d2a7 13/30: Merge branch 'master' of gitlab.com:emacs-geiser/stklos into master, Philip Kaludercic, 2021/08/01
- [nongnu] elpa/geiser-stklos 52acf7c 24/30: Fix fatal thinko (docstring / const value mixup), Philip Kaludercic, 2021/08/01
- [nongnu] elpa/geiser-stklos be482a0 30/30: Fix tests and describe them in README, Philip Kaludercic, 2021/08/01
- [nongnu] elpa/geiser-stklos eb2b13f 02/30: Geiser functions are now in a STklos module, Philip Kaludercic, 2021/08/01
- [nongnu] elpa/geiser-stklos 2fe100a 12/30: Update README, Philip Kaludercic, 2021/08/01
- [nongnu] elpa/geiser-stklos 2733115 18/30: Add missing end marker in .el file, Philip Kaludercic, 2021/08/01
- [nongnu] elpa/geiser-stklos 033b585 16/30: Fix headers for inclusion in MELPA, Philip Kaludercic, 2021/08/01
- [nongnu] elpa/geiser-stklos d4aa8df 19/30: Some changes to headers, Philip Kaludercic, 2021/08/01
- [nongnu] elpa/geiser-stklos 47cbf16 26/30: Fixing docstrings and style issues, Philip Kaludercic, 2021/08/01
- [nongnu] elpa/geiser-stklos 0e3a057 28/30: Enhance documentation in Commentary section,
Philip Kaludercic <=
- [nongnu] elpa/geiser-stklos fc33f45 01/30: Initial Commit, Philip Kaludercic, 2021/08/01
- [nongnu] elpa/geiser-stklos 38dba89 09/30: Minimum version of STklos supported is 1.50, Philip Kaludercic, 2021/08/01
- [nongnu] elpa/geiser-stklos 1f2a6e6 08/30: Update README.md - mention autodoc issue, Philip Kaludercic, 2021/08/01
- [nongnu] elpa/geiser-stklos 80b05d0 03/30: Disable autodoc, Philip Kaludercic, 2021/08/01
- [nongnu] elpa/geiser-stklos 4ca3c84 23/30: Version 1.3, Philip Kaludercic, 2021/08/01