Some misc docstring fixups

This commit is contained in:
Evie Litherland-Smith 2024-02-15 06:29:57 +00:00
parent f7eb8fa03d
commit 4816089817

View file

@ -38,19 +38,19 @@ think. For example, if you wanted to use spaces instead of tabs
globally except for in Makefiles, doing the following won't work: globally except for in Makefiles, doing the following won't work:
;; turns on `global-whitespace-mode' to use spaces instead of tabs ;; turns on `global-whitespace-mode' to use spaces instead of tabs
(crafted-writing-configure-whitespace nil t) \(crafted-writing-configure-whitespace nil t)
;; overwrites the above to turn to use tabs instead of spaces, ;; overwrites the above to turn to use tabs instead of spaces,
;; does not turn off `global-whitespace-mode', adds a hook to ;; does not turn off `global-whitespace-mode', adds a hook to
;; makefile-mode-hook ;; makefile-mode-hook
(crafted-writing-configure-whitespace t nil 'makefile-mode) \(crafted-writing-configure-whitespace t nil 'makefile-mode)
Instead, use a configuration like this: Instead, use a configuration like this:
;; turns on `global-whitespace-mode' to use spaces instead of tabs ;; turns on `global-whitespace-mode' to use spaces instead of tabs
(crafted-writing-configure-whitespace nil t) \(crafted-writing-configure-whitespace nil t)
;; turn on the buffer-local mode for using tabs instead of spaces. ;; turn on the buffer-local mode for using tabs instead of spaces.
(add-hook 'makefile-mode-hook #'indent-tabs-mode) \(add-hook 'makefile-mode-hook #'indent-tabs-mode)
For more information on `indent-tabs-mode', See the info For more information on `indent-tabs-mode', See the info
node `(emacs)Just Spaces' node `(emacs)Just Spaces'
@ -61,14 +61,14 @@ Example usage:
;; since we don't know which modes to turn it on for. ;; since we don't know which modes to turn it on for.
;; You will need to do that in your configuration by adding ;; You will need to do that in your configuration by adding
;; whitespace mode to the appropriate mode hooks. ;; whitespace mode to the appropriate mode hooks.
(crafted-writing-configure-whitespace nil) \(crafted-writing-configure-whitespace nil)
;; Configure whitespace mode, but turn it on globally. ;; Configure whitespace mode, but turn it on globally.
(crafted-writing-configure-whitespace nil t) \(crafted-writing-configure-whitespace nil t)
;; Configure whitespace mode and turn it on only for `prog-mode' ;; Configure whitespace mode and turn it on only for `prog-mode'
;; and derived modes. ;; and derived modes.
(crafted-writing-configure-whitespace nil nil 'prog-mode)" \(crafted-writing-configure-whitespace nil nil 'prog-mode)"
(if use-tabs (if use-tabs
(customize-set-variable 'whitespace-style (customize-set-variable 'whitespace-style
'(face empty trailing indentation::tab '(face empty trailing indentation::tab