Skip to content

Commit b1494c3

Browse files
committed
(minor) rumdl check for lists starting with no newline
for #509 rumdl check *.md --color never .rumdl.toml: enable = ["MD032"]
1 parent 6f05fab commit b1494c3

File tree

6 files changed

+40
-55
lines changed

6 files changed

+40
-55
lines changed

debugging.md

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -400,8 +400,7 @@ How it works: (the following instructions are for SLIME)
400400
1. Select the functions to trace using `M-x slime-trace-dialog-toggle-trace` bound to `C-c M-t`.
401401
2. Evaluate code that calls the traced functions.
402402
3. Open the trace dialog tool via `M-x slime-trace-dialog` bound to `C-c T`.
403-
4. The list of traced functions appear under `Traced specs`.
404-
Traces are fetched in batches. So use the the `[refresh]` button to update status information about tracing (number of available traces that can be fetched).
403+
4. The list of traced functions appear under `Traced specs`. Traces are fetched in batches. So use the the `[refresh]` button to update status information about tracing (number of available traces that can be fetched).
405404
5. Then use either the `[fetch next batch]` or `[fetch all]` buttons to fetch the traces. Traces appear under `Traced specs` after that, and you can use the SLIME inspector to visualize their data (arguments and return values).
406405
6. After more code that calls the traced functions is evaluated, repeat the process (go to step 4).
407406

emacs-ide.md

Lines changed: 36 additions & 48 deletions
Original file line numberDiff line numberDiff line change
@@ -6,26 +6,24 @@ This page is meant to provide an introduction to using [Emacs](https://www.gnu.o
66

77
We divided it roughly into 3 sections: how to install Slime (or Sly), how to use it, and complementary information on built-in Emacs commands to work with Lisp code.
88

9-
![](assets/emacs-teaser.png)
9+
![Emacs teaser image](assets/emacs-teaser.png)
1010

1111
<!-- todo: C-u M-x slime and its configuration to work with multiple implementations -->
1212

13-
1413
By the way, if you wonder, why use Emacs?
1514

16-
* Emacs has fantastic support for working with Lisp code
15+
* Emacs has fantastic support for working with Lisp code
1716
* the Slime-Swank client-server model predates LSP and is much richer for Common Lisp integration.
18-
* it runs on virtually every OS and with every CL implementation, it is lightweight
19-
* Emacs will probably always be around
20-
* Emacs works well either with a mouse or without a mouse
21-
* Emacs works well either in GUI mode or in the terminal
22-
* Built-in tree-sitter and LSP support
23-
* Excellent vim mode
24-
* Because [Org-mode](http://orgmode.org)
25-
* Because [Magit](https://magit.vc/)
26-
* Because [Emacs Rocks !](http://emacsrocks.com)
27-
* Large user base and vast number of extensions: [awesome-emacs](https://github.com/emacs-tw/awesome-emacs).
28-
17+
* it runs on virtually every OS and with every CL implementation, it is lightweight
18+
* Emacs will probably always be around
19+
* Emacs works well either with a mouse or without a mouse
20+
* Emacs works well either in GUI mode or in the terminal
21+
* Built-in tree-sitter and LSP support
22+
* Excellent vim mode
23+
* Because [Org-mode](http://orgmode.org)
24+
* Because [Magit](https://magit.vc/)
25+
* Because [Emacs Rocks !](http://emacsrocks.com)
26+
* Large user base and vast number of extensions: [awesome-emacs](https://github.com/emacs-tw/awesome-emacs).
2927

3028
## SLIME: Superior Lisp Interaction Mode for Emacs
3129

@@ -60,11 +58,11 @@ the following changes and features:
6058
* Multiple REPLs and multiple inspectors.
6159
* Regexp-capable `M-x sly-apropos`.
6260
* Contribs are first class SLY citizens, enabled by default, loaded with ASDF on demand:
63-
- [NAMED-READTABLES](https://github.com/joaotavora/sly-named-readtables) support
64-
- [macrostep.el](https://github.com/joaotavora/sly-macrostep)
65-
- [Quicklisp](https://github.com/joaotavora/sly-quicklisp)
66-
- [ASDF](https://github.com/mmgeorge/sly-asdf)
67-
- [Evaluation Overlays](https://git.sr.ht/~fosskers/sly-overlay)
61+
* [NAMED-READTABLES](https://github.com/joaotavora/sly-named-readtables) support
62+
* [macrostep.el](https://github.com/joaotavora/sly-macrostep)
63+
* [Quicklisp](https://github.com/joaotavora/sly-quicklisp)
64+
* [ASDF](https://github.com/mmgeorge/sly-asdf)
65+
* [Evaluation Overlays](https://git.sr.ht/~fosskers/sly-overlay)
6866

6967
On the other side, we noticed some lacks or differences:
7068

@@ -132,23 +130,22 @@ modules](https://common-lisp.net/project/slime/doc/html/Contributed-Packages.htm
132130
must be loaded to add further functionalities. The afored mentioned
133131
`slime-fancy` includes:
134132

135-
136-
- slime-autodoc
137-
- slime-c-p-c
138-
- slime-editing-commands
139-
- slime-fancy-inspector
140-
- slime-fancy-trace
141-
- slime-fontifying-fu
142-
- slime-fuzzy
143-
- slime-mdot-fu
144-
- slime-macrostep
145-
- slime-presentations
146-
- slime-references
147-
- slime-repl
148-
- slime-scratch
149-
- slime-package-fu
150-
- slime-trace-dialog
151-
- [slime-mrepl](https://slime.common-lisp.dev/doc/html/slime_002dmrepl.html#slime_002dmrepl) (multiple REPLs)
133+
* slime-autodoc
134+
* slime-c-p-c
135+
* slime-editing-commands
136+
* slime-fancy-inspector
137+
* slime-fancy-trace
138+
* slime-fontifying-fu
139+
* slime-fuzzy
140+
* slime-mdot-fu
141+
* slime-macrostep
142+
* slime-presentations
143+
* slime-references
144+
* slime-repl
145+
* slime-scratch
146+
* slime-package-fu
147+
* slime-trace-dialog
148+
* [slime-mrepl](https://slime.common-lisp.dev/doc/html/slime_002dmrepl.html#slime_002dmrepl) (multiple REPLs)
152149

153150
SLIME also has some nice extensions like
154151
[Helm-SLIME](https://github.com/emacs-helm/helm-slime) which features, among
@@ -886,19 +883,10 @@ Additionnaly, use `M-x check-parens` to spot malformed s-exps.
886883

887884
There are additional packages that can make your use of parens easier:
888885

889-
- `M-x show-paren-mode`, a built-in Emacs mode: it toggles the
890-
visualization of matching parenthesis. When enabled, place the
891-
cursor on a paren and you'll see the other paren it matches
892-
with. You can initialize it in your Emacs init file with
893-
`(show-paren-mode t)`. It is a global minor mode (it will work for
894-
all buffers, all languages).
895-
- **we highly suggest you enable it**.
886+
- `M-x show-paren-mode`, a built-in Emacs mode: it toggles the visualization of matching parenthesis. When enabled, place the cursor on a paren and you'll see the other paren it matches with. You can initialize it in your Emacs init file with `(show-paren-mode t)`. It is a global minor mode (it will work for all buffers, all languages).
887+
- **we highly suggest you enable it**.
896888
- when evil-mode (the vim layer) is enabled, you can use the `%` key to go to the matchin paren.
897-
- `M-x electric-pair-mode`, a built-in Emacs mode: when enabled,
898-
typing an open parenthesis automatically inserts the corresponding
899-
closing parenthesis, and vice versa. (Likewise for brackets, etc.).
900-
If the region is active, the parentheses (brackets, etc.) are inserted
901-
around the region instead.
889+
- `M-x electric-pair-mode`, a built-in Emacs mode: when enabled, typing an open parenthesis automatically inserts the corresponding closing parenthesis, and vice versa. (Likewise for brackets, etc.). If the region is active, the parentheses (brackets, etc.) are inserted around the region instead.
902890
- you could use [Paredit (animated guide)](http://danmidwood.com/content/2014/11/21/animated-paredit.html) to automatically insert parentheses in pairs,
903891
- or [lispy-mode](https://github.com/abo-abo/lispy), like Paredit, but a key triggers an action when the cursor is placed right before or right after a parentheses.
904892

iteration.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -645,6 +645,7 @@ a macro which turns (via
645645
[`macrolet`](http://www.lispworks.com/documentation/HyperSpec/Body/s_flet_.htm))
646646
its first argument into an iterator that on each invocation returns
647647
three values per hash table entry:
648+
648649
- a generalized boolean that's true if an entry is returned,
649650
- the key of the entry,
650651
- and the value of the entry.

lispworks.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -152,6 +152,7 @@ Similar ones include:
152152
Some useful functions don't have a keybinding by default, for example:
153153

154154
<!-- - delete selected text with `M-x delete-region` (or kill the region with `C-w`) -->
155+
155156
- clear the REPL with `M-x Clear Listener`
156157
- `Backward Kill Line`
157158

macros.md

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -760,9 +760,7 @@ Read more on the [Community Spec](https://cl-community-spec.github.io/pages/symb
760760
## See also
761761

762762
* [A gentle introduction to Compile-Time Computing — Part 1](https://medium.com/@MartinCracauer/a-gentle-introduction-to-compile-time-computing-part-1-d4d96099cea0)
763-
764763
* [Safely dealing with scientific units of variables at compile time (a gentle introduction to Compile-Time Computing — part 3)](https://medium.com/@MartinCracauer/a-gentle-introduction-to-compile-time-computing-part-3-scientific-units-8e41d8a727ca)
765-
766764
* The following video, from the series ["Little bits of
767765
Lisp"](https://www.youtube.com/user/CBaggers/playlists) by
768766
[cbaggers](https://github.com/cbaggers/), is a two hours long talk on

web.md

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1078,9 +1078,7 @@ Lisp. For example:
10781078
- [clfoundation/sbcl](https://hub.docker.com/r/clfoundation/sbcl/)
10791079
includes the latest version of SBCL, many OS packages useful for CI
10801080
purposes, and a script to install Quicklisp.
1081-
- [40ants/base-lisp-image](https://github.com/40ants/base-lisp-image)
1082-
is based on Ubuntu LTS and includes SBCL, CCL, Quicklisp, Qlot and
1083-
Roswell.
1081+
- [40ants/base-lisp-image](https://github.com/40ants/base-lisp-image) is based on Ubuntu LTS and includes SBCL, CCL, Quicklisp, Qlot and Roswell.
10841082
- [container-lisp/s2i-lisp](https://github.com/container-lisp/s2i-lisp)
10851083
is CentOs based and contains the source for building a Quicklisp based
10861084
Common Lisp application as a reproducible docker image using OpenShift's

0 commit comments

Comments
 (0)