TakeV/spacemacs
1
0
Fork 0
Code Issues Pull requests Packages Projects Releases Wiki Activity

[core] Fix ugly comment formating

Browse source 
In my last commit I have messed up the comment
formats so that they not longer show correctly
in help buffers. This fixes it.
This commit is contained in:
Maximilian Wolff 2020-08-11 00:16:09 +02:00
parent 793898f818
commit ca2cdd0fcc
No known key found for this signature in database
GPG key ID: 2DD07025BFDBD89A
1 changed files with 19 additions and 19 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

38
core/core-dotspacemacs.el
View file

@ -457,11 +457,11 @@ and todos. If non nil only the file name is shown.")
(defvar dotspacemacs--pretty-ignore-subdirs (defvar dotspacemacs--pretty-ignore-subdirs
'(".cache/junk") '(".cache/junk")
"Subdirectories of `spacemacs-start-directory' to ignore when "Subdirectories of `spacemacs-start-directory' to ignore when
prettifying Org files.") prettifying Org files.")
(defun dotspacemacs//prettify-spacemacs-docs () (defun dotspacemacs//prettify-spacemacs-docs ()
"Run `spacemacs/prettify-org-buffer' if `buffer-file-name' "Run `spacemacs/prettify-org-buffer' if `buffer-file-name'
looks like Spacemacs documentation." looks like Spacemacs documentation."
(when (and dotspacemacs-pretty-docs (when (and dotspacemacs-pretty-docs
spacemacs-start-directory spacemacs-start-directory
buffer-file-name) buffer-file-name)
@ -477,8 +477,8 @@ and todos. If non nil only the file name is shown.")
(defmacro dotspacemacs|call-func (func &optional msg) (defmacro dotspacemacs|call-func (func &optional msg)
"Call the function from the dotfile only if it is bound. "Call the function from the dotfile only if it is bound.
If MSG is not nil then display a message in `*Messages*'. Errors If MSG is not nil then display a message in `*Messages*'. Errors
are caught and signaled to user in spacemacs buffer." are caught and signaled to user in spacemacs buffer."
`(progn `(progn
(when ,msg (spacemacs-buffer/message ,msg)) (when ,msg (spacemacs-buffer/message ,msg))
(when (fboundp ',func) (when (fboundp ',func)
@ -508,7 +508,7 @@ and todos. If non nil only the file name is shown.")
(defun dotspacemacs//check-layers-changed () (defun dotspacemacs//check-layers-changed ()
"Check if the value of `dotspacemacs-configuration-layers' "Check if the value of `dotspacemacs-configuration-layers'
changed, and issue a warning if it did." changed, and issue a warning if it did."
(unless (eq dotspacemacs-configuration-layers (unless (eq dotspacemacs-configuration-layers
dotspacemacs--configuration-layers-saved) dotspacemacs--configuration-layers-saved)
(spacemacs-buffer/warning (concat (spacemacs-buffer/warning (concat
@ -519,8 +519,8 @@ and todos. If non nil only the file name is shown.")
(defun dotspacemacs//read-editing-style-config (config) (defun dotspacemacs//read-editing-style-config (config)
"Read editing style CONFIG: apply variables and return the editing style. "Read editing style CONFIG: apply variables and return the editing style.
CONFIG can be the symbol of an editing style or a list where the car is CONFIG can be the symbol of an editing style or a list where the car is
the symbol of an editing style and the cdr is a list of keyword arguments like the symbol of an editing style and the cdr is a list of keyword arguments like
`:variables'." `:variables'."
(cond (cond
((symbolp config) config) ((symbolp config) config)
@ -543,7 +543,7 @@ and todos. If non nil only the file name is shown.")
(defun dotspacemacs/add-layer (layer-name) (defun dotspacemacs/add-layer (layer-name)
"Add LAYER_NAME to dotfile and reload the it. "Add LAYER_NAME to dotfile and reload the it.
Returns non nil if the layer has been effectively inserted." Returns non nil if the layer has been effectively inserted."
(unless (configuration-layer/layer-used-p layer-name) (unless (configuration-layer/layer-used-p layer-name)
(with-current-buffer (find-file-noselect (dotspacemacs/location)) (with-current-buffer (find-file-noselect (dotspacemacs/location))
(beginning-of-buffer) (beginning-of-buffer)
@ -570,8 +570,8 @@ and todos. If non nil only the file name is shown.")
(defun dotspacemacs/sync-configuration-layers (&optional arg) (defun dotspacemacs/sync-configuration-layers (&optional arg)
"Synchronize declared layers in dotfile with spacemacs. "Synchronize declared layers in dotfile with spacemacs.
Called with `C-u' skips `dotspacemacs/user-config'. Called with `C-u' skips `dotspacemacs/user-config'.
Called with `C-u C-u' skips `dotspacemacs/user-config' _and_ preliminary tests." Called with `C-u C-u' skips `dotspacemacs/user-config' _and_ preliminary tests."
(interactive "P") (interactive "P")
(when (file-exists-p dotspacemacs-filepath) (when (file-exists-p dotspacemacs-filepath)
(with-current-buffer (find-file-noselect dotspacemacs-filepath) (with-current-buffer (find-file-noselect dotspacemacs-filepath)
@ -622,8 +622,8 @@ and todos. If non nil only the file name is shown.")
(defmacro dotspacemacs|symbol-value (symbol) (defmacro dotspacemacs|symbol-value (symbol)
"Return the value of SYMBOL corresponding to a dotspacemacs variable. "Return the value of SYMBOL corresponding to a dotspacemacs variable.
If SYMBOL value is `display-graphic-p' then return the result of If SYMBOL value is `display-graphic-p' then return the result of
`(display-graphic-p)', otherwise return the value of the symbol." `(display-graphic-p)', otherwise return the value of the symbol."
`(if (eq 'display-graphic-p ,symbol) (display-graphic-p) ,symbol)) `(if (eq 'display-graphic-p ,symbol) (display-graphic-p) ,symbol))
(defun dotspacemacs/location () (defun dotspacemacs/location ()
@ -632,7 +632,7 @@ and todos. If non nil only the file name is shown.")
(defun dotspacemacs/copy-template () (defun dotspacemacs/copy-template ()
"Copy `.spacemacs.template' in home directory. Ask for confirmation "Copy `.spacemacs.template' in home directory. Ask for confirmation
before copying the file if the destination already exists." before copying the file if the destination already exists."
(interactive) (interactive)
(let* ((copy? (if (file-exists-p dotspacemacs-filepath) (let* ((copy? (if (file-exists-p dotspacemacs-filepath)
(y-or-n-p (y-or-n-p
@ -646,7 +646,7 @@ and todos. If non nil only the file name is shown.")
(defun dotspacemacs//ido-completing-read (prompt candidates) (defun dotspacemacs//ido-completing-read (prompt candidates)
"Call `ido-completing-read' with a CANDIDATES alist where the key is "Call `ido-completing-read' with a CANDIDATES alist where the key is
a display strng and the value is the actual value to return." a display strng and the value is the actual value to return."
(let ((ido-max-window-height (1+ (length candidates)))) (let ((ido-max-window-height (1+ (length candidates))))
(cadr (assoc (ido-completing-read prompt (mapcar 'car candidates)) (cadr (assoc (ido-completing-read prompt (mapcar 'car candidates))
candidates)))) candidates))))
@ -661,7 +661,7 @@ and todos. If non nil only the file name is shown.")
(defun dotspacemacs/install (arg) (defun dotspacemacs/install (arg)
"Install the dotfile, return non nil if the doftile has been installed. "Install the dotfile, return non nil if the doftile has been installed.
If ARG is non nil then ask questions to the user before installing the dotfile." If ARG is non nil then ask questions to the user before installing the dotfile."
(interactive "P") (interactive "P")
;; preferences is an alist where the key is the text to replace by ;; preferences is an alist where the key is the text to replace by
;; the value in the dotfile ;; the value in the dotfile
@ -787,9 +787,9 @@ and todos. If non nil only the file name is shown.")
(defun dotspacemacs/safe-load () (defun dotspacemacs/safe-load ()
"Error recovery from malformed .spacemacs. "Error recovery from malformed .spacemacs.
Loads default .spacemacs template and suspends pruning of orphan packages. Loads default .spacemacs template and suspends pruning of orphan packages.
Informs users of error and prompts for default editing style for use during Informs users of error and prompts for default editing style for use during
error recovery." error recovery."
(load (concat dotspacemacs-template-directory (load (concat dotspacemacs-template-directory
".spacemacs.template")) ".spacemacs.template"))
(defadvice dotspacemacs/layers (defadvice dotspacemacs/layers
@ -942,7 +942,7 @@ and todos. If non nil only the file name is shown.")
(defun dotspacemacs/test-dotfile (&optional hide-buffer) (defun dotspacemacs/test-dotfile (&optional hide-buffer)
"Test settings in dotfile for correctness. "Test settings in dotfile for correctness.
Return non-nil if all the tests passed." Return non-nil if all the tests passed."
(interactive) (interactive)
(configuration-layer/discover-layers 'refresh-index) (configuration-layer/discover-layers 'refresh-index)
(let ((min-version "0.0")) (let ((min-version "0.0"))