]> git.eshelyaron.com Git - emacs.git/commitdiff
; Improve use-package Commentary sections
authorStefan Kangas <stefankangas@gmail.com>
Thu, 8 Dec 2022 23:24:15 +0000 (00:24 +0100)
committerStefan Kangas <stefankangas@gmail.com>
Thu, 8 Dec 2022 23:32:30 +0000 (00:32 +0100)
* lisp/use-package/bind-key.el:
* lisp/use-package/use-package-bind-key.el:
* lisp/use-package/use-package-core.el:
* lisp/use-package/use-package-ensure-system-package.el:
* lisp/use-package/use-package-ensure.el:
* lisp/use-package/use-package.el: Improve Commentary sections.

lisp/use-package/bind-key.el
lisp/use-package/use-package-bind-key.el
lisp/use-package/use-package-core.el
lisp/use-package/use-package-delight.el
lisp/use-package/use-package-diminish.el
lisp/use-package/use-package-ensure-system-package.el
lisp/use-package/use-package-ensure.el
lisp/use-package/use-package-jump.el
lisp/use-package/use-package-lint.el
lisp/use-package/use-package.el

index 52e797b7bb9ac3f6df8c67de5cb7edf510df4482..9a1d65ba5efe0000396ab5d2331d6a9114f0fbe6 100644 (file)
 
 ;;; Commentary:
 
-;; If you have lots of keybindings set in your .emacs file, it can be hard to
-;; know which ones you haven't set yet, and which may now be overriding some
-;; new default in a new Emacs version.  This module aims to solve that
-;; problem.
+;; If you have lots of keybindings set in your init file, it can be
+;; hard to know which ones you haven't set yet, and which may now be
+;; overriding some new default in a new Emacs version.  This module
+;; aims to solve that problem.
 ;;
-;; Bind keys as follows in your .emacs:
-;;
-;;   (require 'bind-key)
+;; Bind keys as follows in your init file:
 ;;
 ;;   (bind-key "C-c x" 'my-ctrl-c-x-command)
 ;;
@@ -97,6 +95,8 @@
 ;; This display will tell you if you've overridden a default keybinding, and
 ;; what the default was.  Also, it will tell you if the key was rebound after
 ;; your binding it with `bind-key', and what it was rebound it to.
+;;
+;; See the `use-package' info manual for more information.
 
 ;;; Code:
 
index a9e921a478a6a075e2fb0547e5c108c75dbe1492..44242c9e01dddcdb26ab013109fdf463ad18f1f3 100644 (file)
 ;; keywords.  Note that these are currently still baked into
 ;; `use-package-keywords' and `use-package-deferring-keywords', although this
 ;; is harmless if they are never used.
+;;
+;; These keywords are made available by default by requiring `use-package'.
+;;
+;; See the `use-package' info manual for more information.
 
 ;;; Code:
 
index edc9fc689df482c1edeb63f81a0b51233dc0f522..868a65803a49883ee9f836812bcaf85bf7b47602 100644 (file)
 
 ;;; Commentary:
 
-;; The `use-package' declaration macro allows you to isolate package
-;; configuration in your ".emacs" in a way that is performance-oriented and,
-;; well, just tidy.  I created it because I have over 80 packages that I use
-;; in Emacs, and things were getting difficult to manage.  Yet with this
-;; utility my total load time is just under 1 second, with no loss of
-;; functionality!
+;; This file contains the core implementation of the `use-package'
+;; macro.
 ;;
-;; Please see README.md from the same repository for documentation.
+;; See the `use-package' info manual for more information.
 
 ;;; Code:
 
index 7d50e4acda5f8e9d509ceb2b7d54d3f065eefc3c..41978b94f4949dc606baa4011c2274bf70fb87da 100644 (file)
 
 ;;; Commentary:
 
-;; Provides support for the :delight keyword, which is made available by
-;; default by requiring `use-package'.
+;; Provides support for the :delight keyword, which is made available
+;; by default by requiring `use-package'.  Using it requires the
+;; `delight' package to be installed (available on GNU ELPA).
+;;
+;; See the `use-package' info manual for more information.
 
 ;;; Code:
 
index f6c286152d43011cf1ed9252a14fbecf7ea4c025..7fff93b0e9bf8b879502847d12259901736af55c 100644 (file)
 
 ;;; Commentary:
 
-;; Provides support for the :diminish keyword, which is made available by
-;; default by requiring `use-package'.
+;; Provides support for the :diminish keyword, which is made available
+;; by default by requiring `use-package'.  Using it requires the
+;; `diminish' package to be installed (available on GNU ELPA).
+;;
+;; See the `use-package' info manual for more information.
 
 ;;; Code:
 
index 867d8a18b4db40a2bb8ef6b3d490a472c03c2b7d..6681e5afb725219b088f6672079349b5a2ee33dc 100644 (file)
 ;;; Commentary:
 
 ;; The `:ensure-system-package` keyword allows you to ensure system
-;; binaries exist alongside your `use-package` declarations.
+;; binaries exist alongside your `use-package` declarations.  Using it
+;; requires the `system-packages' package to be installed (available
+;; on GNU ELPA).
+;;
+;; See the `use-package' info manual for more information.
 
 ;;; Code:
 
index c8f05c4b40e3b04fd17d6f40110e4f26e7604256..dae0312dbad3a97e1d9fdf4d68408df03a91fe50 100644 (file)
 
 ;;; Commentary:
 
-;; Provides support for the :ensure and :pin keywords, which is made available
-;; by default by requiring `use-package'.
+;; Provides support for the :ensure and :pin keywords, which are made
+;; available by default by requiring `use-package'.
+;;
+;; See the `use-package' info manual for more information.
 
 ;;; Code:
 
index 155c709c535ecc5383d01b418fe109df651fb0e6..6fc52afd2863a9315190bc6f253db824f42ab8a0 100644 (file)
 
 ;;; Commentary:
 
-;; Provides the command `M-x use-package-jump-to-package-form', however it
+;; Provides the command `M-x use-package-jump-to-package-form'.  However, it
 ;; only works if the package being jumped to was required during
-;; initialization.  If it was delay-loaded, it will not work.
+;; initialization.  If it was autoloaded, it will not work.
 ;; Improvements are needed.
+;;
+;; See the `use-package' info manual for more information.
 
 ;;; Code:
 
index 630b1845a090b37fec4775b573d5778a91e4b3f8..498213a76bf1e0e04ecea183b8e47456bfa2bf7c 100644 (file)
@@ -23,6 +23,8 @@
 ;;; Commentary:
 
 ;; Provides the command `M-x use-package-lint'.
+;;
+;; See the `use-package' info manual for more information.
 
 ;;; Code:
 
index 7becd88e6d398482771b99b9a00082bc9883f5ef..0929696466b6e58db9bac3311d8b70d9adcbf322 100644 (file)
 ;;; Commentary:
 
 ;; The `use-package' declaration macro allows you to isolate package
-;; configuration in your ".emacs" in a way that is performance-oriented and,
-;; well, just tidy.  I created it because I have over 80 packages that I use
-;; in Emacs, and things were getting difficult to manage.  Yet with this
-;; utility my total load time is just under 1 second, with no loss of
-;; functionality!
+;; configuration in your init file in a way that is
+;; performance-oriented and, well, just tidy.  I created it because I
+;; have over 80 packages that I use in Emacs, and things were getting
+;; difficult to manage.  Yet with this utility my total load time is
+;; just under 1 second, with no loss of functionality!
 ;;
-;; Please see README.md from the same repository for documentation.
+;; See the `use-package' info manual for more information.
 
 ;;; Code: