Documents enhancement for the use-package

syl20bnr · Jul 18, 2023 · f77bd3e · f77bd3e
1 parent 25484f8
commit f77bd3e
Show file tree

Hide file tree

Showing 2 changed files with 43 additions and 46 deletions.
diff --git a/core/libs/spacemacs-theme/README.md b/core/libs/spacemacs-theme/README.md
@@ -188,43 +188,42 @@ If you don't use spacemacs and want to get the same look of flycheck fringe bitm
 ```elisp
 (use-package flycheck
   :init
-  (progn
-    (define-fringe-bitmap 'my-flycheck-fringe-indicator
-      (vector #b00000000
-              #b00000000
-              #b00000000
-              #b00000000
-              #b00000000
-              #b00000000
-              #b00000000
-              #b00011100
-              #b00111110
-              #b00111110
-              #b00111110
-              #b00011100
-              #b00000000
-              #b00000000
-              #b00000000
-              #b00000000
-              #b00000000))
-
-    (flycheck-define-error-level 'error
-      :severity 2
-      :overlay-category 'flycheck-error-overlay
-      :fringe-bitmap 'my-flycheck-fringe-indicator
-      :fringe-face 'flycheck-fringe-error)
-
-    (flycheck-define-error-level 'warning
-      :severity 1
-      :overlay-category 'flycheck-warning-overlay
-      :fringe-bitmap 'my-flycheck-fringe-indicator
-      :fringe-face 'flycheck-fringe-warning)
-
-    (flycheck-define-error-level 'info
-      :severity 0
-      :overlay-category 'flycheck-info-overlay
-      :fringe-bitmap 'my-flycheck-fringe-indicator
-      :fringe-face 'flycheck-fringe-info)))
+  (define-fringe-bitmap 'my-flycheck-fringe-indicator
+    (vector #b00000000
+            #b00000000
+            #b00000000
+            #b00000000
+            #b00000000
+            #b00000000
+            #b00000000
+            #b00011100
+            #b00111110
+            #b00111110
+            #b00111110
+            #b00011100
+            #b00000000
+            #b00000000
+            #b00000000
+            #b00000000
+            #b00000000))
+
+  (flycheck-define-error-level 'error
+    :severity 2
+    :overlay-category 'flycheck-error-overlay
+    :fringe-bitmap 'my-flycheck-fringe-indicator
+    :fringe-face 'flycheck-fringe-error)
+
+  (flycheck-define-error-level 'warning
+    :severity 1
+    :overlay-category 'flycheck-warning-overlay
+    :fringe-bitmap 'my-flycheck-fringe-indicator
+    :fringe-face 'flycheck-fringe-warning)
+
+  (flycheck-define-error-level 'info
+    :severity 0
+    :overlay-category 'flycheck-info-overlay
+    :fringe-bitmap 'my-flycheck-fringe-indicator
+    :fringe-face 'flycheck-fringe-info))
 ```
 
 ## Like the theme and want to use it in other places?

diff --git a/doc/VIMUSERS.org b/doc/VIMUSERS.org
@@ -438,16 +438,14 @@ to using it:
   (use-package package-name
     :defer t
     :init
-    (progn
-      ;; Change some variables
-      (setq variable1 t variable2 nil)
-      ;; Define a function
-      (defun foo ()
-        (message "%s" "Hello, World!")))
+    ;; Change some variables
+    (setq variable1 t variable2 nil)
+    ;; Define a function
+    (defun foo ()
+      (message "%s" "Hello, World!"))
     :config
-    (progn
-      ;; Calling a function that is defined when the package loads
-      (function-defined-when-package-loads)))
+    ;; Calling a function that is defined when the package loads
+    (function-defined-when-package-loads))
 #+END_SRC
 
 This is just a very basic overview of =use-package=. There are many other ways