From 812d35a100df6dae03a07cd1cb5a9dba1ff5757c Mon Sep 17 00:00:00 2001 From: Eivind Fonn Date: Fri, 9 Oct 2015 12:15:35 +0200 Subject: [PATCH] Doc conventions for lisp layer READMEs --- layers/+lang/clojure/README.org | 34 ++++++++++++----------------- layers/+lang/common-lisp/README.org | 12 +++++----- layers/+lang/emacs-lisp/README.org | 14 +++++------- 3 files changed, 26 insertions(+), 34 deletions(-) diff --git a/layers/+lang/clojure/README.org b/layers/+lang/clojure/README.org index f134775dc..b3bf7005b 100644 --- a/layers/+lang/clojure/README.org +++ b/layers/+lang/clojure/README.org @@ -9,6 +9,7 @@ - [[#layer][Layer]] - [[#pretty-symbols][Pretty Symbols]] - [[#cider-and-clj-refactor][CIDER and clj-refactor]] + - [[#quick-start-with-boot][Quick Start with boot]] - [[#quick-start-with-lein][Quick Start with lein]] - [[#more-details][More details]] - [[#key-bindings][Key Bindings]] @@ -42,7 +43,6 @@ This layer adds support for [[http://clojure.org][Clojure]] language using [[htt * Install ** Layer - To use this contribution add it to your =~/.spacemacs= #+BEGIN_SRC emacs-lisp @@ -50,7 +50,6 @@ To use this contribution add it to your =~/.spacemacs= #+END_SRC ** Pretty Symbols - Pretty symbols for anonymous functions, set literals and partial, like =(λ [a] (+ a 5))=, =ƒ(+ % 5)=, =∈{2 4 6}= and =Ƥ=. @@ -70,7 +69,6 @@ Or set this variable when loading the configuration layer: ** CIDER and clj-refactor *** Quick Start with boot - - Install =boot= (see https://github.com/boot-clj/boot#install) - Create a file =~/.boot/profile.boot= with the following content: @@ -88,7 +86,6 @@ Or set this variable when loading the configuration layer: - Run ~SPC m s i~ in any of the clojure source files to connect to the CIDER REPL. *** Quick Start with lein - - Install =lein= via your OS package manager. - Create a file =~/.lein/profiles.clj= with the following content: @@ -104,23 +101,22 @@ Or set this variable when loading the configuration layer: source files to connect to the CIDER REPL. *** More details - More info regarding installation of nREPL middleware can be found here: - CIDER: [[https://github.com/clojure-emacs/cider#installation][cider_install]] - clj-refactor: [[https://github.com/clojure-emacs/refactor-nrepl][refactor-nrepl]] * Key Bindings ** Working with clojure files (barfage, slurpage & more) +Spacemacs comes with a special ~lisp-state~ for working with lisp code that +supports slurpage, barfage and more tools you'll likely want when working with +lisp. -spacemacs comes with a special ~lisp-state~ for working with lisp code that supports slurpage, barfage and more tools you'll likely want when working with lisp. - -As this state works for all files the same, the documentation for it has been added into the global [[https://github.com/syl20bnr/spacemacs/blob/master/doc/DOCUMENTATION.org#lisp-key-bindings][DOCUMENTATION.org]]. In general, use ~SPC k~ to interact with the lisp-state. +As this state works the same for all files, the documentation is in global +[[https://github.com/syl20bnr/spacemacs/blob/master/doc/DOCUMENTATION.org#lisp-key-bindings][DOCUMENTATION.org]]. In general, use ~SPC k~ to interact with the lisp-state. ** Leader - *** Documentation - | Key Binding | Description | |-------------+----------------| | ~SPC m h g~ | cider grimoire | @@ -178,18 +174,18 @@ As this state works for all files the same, the documentation for it has been ad | Key Binding | Description | |-------------+-----------------------------| -| ~SPC m T f~ | toggle REPL font-locking | -| ~SPC m T p~ | toggle REPL pretty-printing | -| ~SPC m T i~ | toggle indentation style | +| ~SPC m T f~ | toggle REPL font-locking | +| ~SPC m T p~ | toggle REPL pretty-printing | +| ~SPC m T i~ | toggle indentation style | *** Debugging | Key Binding | Description | |-------------+--------------------------------| -| ~SPC m d r~ | reload namepspaces | -| ~SPC m d b~ | instrument expression at point | -| ~SPC m d e~ | display last stacktrace | -| ~SPC m d i~ | inspect expression at point | +| ~SPC m d r~ | reload namepspaces | +| ~SPC m d b~ | instrument expression at point | +| ~SPC m d e~ | display last stacktrace | +| ~SPC m d i~ | inspect expression at point | *** Refactoring @@ -238,8 +234,7 @@ As this state works for all files the same, the documentation for it has been ad | ~SPC m r u w~ | unwind | *** Reformatting - -- Forms currently handled: +Forms currently handled: - let - when-let - if-let @@ -259,7 +254,6 @@ More info at [[https://github.com/gstamp/align-cljlet][align-cljlet]]. | ~SPC m f b~ | reformat current buffer | ** CIDER Buffers - In general, ~q~ should always quit the popped up buffer. *** stacktrace-mode diff --git a/layers/+lang/common-lisp/README.org b/layers/+lang/common-lisp/README.org index d1f91bc98..899b5bf28 100644 --- a/layers/+lang/common-lisp/README.org +++ b/layers/+lang/common-lisp/README.org @@ -16,11 +16,9 @@ - [[#macroexpansion][Macroexpansion]] * Description - A Spacemacs contribution layer providing Common Lisp support via [[https://github.com/slime/slime][SLIME]]. * Install - If you have previously installed slime in any other way, it is recommended that you uninstall it before proceeding. You should clean up any config files tied to slime that are left behind as well. Linux users can just purge the slime package @@ -41,12 +39,13 @@ of Common Lisp, you can specify it in your =~/.spacemacs= #+END_SRC * Key Bindings - ** Working with lisp files (barfage, slurpage & more) +Spacemacs comes with a special ~lisp-state~ for working with lisp code that +supports slurpage, barfage and more tools you'll likely want when working with +lisp. -spacemacs comes with a special ~lisp-state~ for working with lisp code that supports slurpage, barfage and more tools you'll likely want when working with lisp. - -As this state works for all files the same, the documentation for it has been added into the global [[https://github.com/syl20bnr/spacemacs/blob/master/doc/DOCUMENTATION.org#lisp-key-bindings][DOCUMENTATION.org]]. In general, use ~SPC k~ to interact with the lisp-state. +As this state works the same for all files, the documentation is in global +[[https://github.com/syl20bnr/spacemacs/blob/master/doc/DOCUMENTATION.org#lisp-key-bindings][DOCUMENTATION.org]]. In general, use ~SPC k~ to interact with the lisp-state. ** Leader *** Help @@ -104,6 +103,7 @@ As this state works for all files the same, the documentation for it has been ad | ~SPC m g b~ | Go back | | ~SPC m g n~ | Next note | | ~SPC m g N~ or ~SPC m g p | Previous note | + *** Macroexpansion | Key Binding | Description | diff --git a/layers/+lang/emacs-lisp/README.org b/layers/+lang/emacs-lisp/README.org index fbabd3039..9e143e70e 100644 --- a/layers/+lang/emacs-lisp/README.org +++ b/layers/+lang/emacs-lisp/README.org @@ -11,12 +11,10 @@ - [[#srefactor][srefactor]] * Description - This layer gathers all the configuration related to emacs-lisp. This should always be in your dotfile, it is not recommended to uninstall it. * Install - To use this contribution add it to your =~/.spacemacs= #+BEGIN_SRC emacs-lisp @@ -25,10 +23,12 @@ To use this contribution add it to your =~/.spacemacs= * Key bindings ** Working with lisp files (barfage, slurpage & more) +Spacemacs comes with a special ~lisp-state~ for working with lisp code that +supports slurpage, barfage and more tools you'll likely want when working with +lisp. -spacemacs comes with a special ~lisp-state~ for working with lisp code that supports slurpage, barfage and more tools you'll likely want when working with lisp. - -As this state works for all files the same, the documentation for it has been added into the global [[https://github.com/syl20bnr/spacemacs/blob/master/doc/DOCUMENTATION.org#lisp-key-bindings][DOCUMENTATION.org]]. In general, use ~SPC k~ to interact with the lisp-state. +As this state works the same for all files, the documentation is in global +[[https://github.com/syl20bnr/spacemacs/blob/master/doc/DOCUMENTATION.org#lisp-key-bindings][DOCUMENTATION.org]]. In general, use ~SPC k~ to interact with the lisp-state. ** Leader @@ -48,9 +48,7 @@ As this state works for all files the same, the documentation for it has been ad | ~SPC m d m~ | open [[https://github.com/joddie/macrostep][macrostep]] micro-state | ** srefactor - -The [[file:../../semantic/README.org][semantic-layer]] should be installed for these key bindings -to become active. +The [[file:../../semantic/README.org][semantic]] layer should be installed for these key bindings to become active. | Key Binding | Description | |-------------+-------------------------|