diff options
| author | Stefan Monnier | 2017-05-19 09:42:57 -0400 |
|---|---|---|
| committer | Stefan Monnier | 2017-05-19 09:42:57 -0400 |
| commit | b372e565e4b2b9aaedfdc7d4a43ebc7ad3f66120 (patch) | |
| tree | 404767a88860a4c4d00f2bd5b5e22bc15231c40c | |
| parent | c1c6f167b2e683db3e2cee7cb29ab2eb745e1713 (diff) | |
| download | emacs-b372e565e4b2b9aaedfdc7d4a43ebc7ad3f66120.tar.gz emacs-b372e565e4b2b9aaedfdc7d4a43ebc7ad3f66120.zip | |
* lisp/emacs-lisp/package.el: Quote `package-desc' in docstrings
| -rw-r--r-- | lisp/emacs-lisp/package.el | 24 |
1 files changed, 12 insertions, 12 deletions
diff --git a/lisp/emacs-lisp/package.el b/lisp/emacs-lisp/package.el index c0ecb0447f3..551f440a8f9 100644 --- a/lisp/emacs-lisp/package.el +++ b/lisp/emacs-lisp/package.el | |||
| @@ -638,7 +638,7 @@ Return the max version (as a string) if the package is held at a lower version." | |||
| 638 | (t (error "Invalid element in `package-load-list'"))))) | 638 | (t (error "Invalid element in `package-load-list'"))))) |
| 639 | 639 | ||
| 640 | (defun package-built-in-p (package &optional min-version) | 640 | (defun package-built-in-p (package &optional min-version) |
| 641 | "Return true if PACKAGE is built-in to Emacs. | 641 | "Return non-nil if PACKAGE is built-in to Emacs. |
| 642 | Optional arg MIN-VERSION, if non-nil, should be a version list | 642 | Optional arg MIN-VERSION, if non-nil, should be a version list |
| 643 | specifying the minimum acceptable version." | 643 | specifying the minimum acceptable version." |
| 644 | (if (package-desc-p package) ;; was built-in and then was converted | 644 | (if (package-desc-p package) ;; was built-in and then was converted |
| @@ -1776,7 +1776,7 @@ destructively set to nil in ONLY." | |||
| 1776 | That is, any element of the returned list is guaranteed to not | 1776 | That is, any element of the returned list is guaranteed to not |
| 1777 | directly depend on any elements that come before it. | 1777 | directly depend on any elements that come before it. |
| 1778 | 1778 | ||
| 1779 | PACKAGE-LIST is a list of package-desc objects. | 1779 | PACKAGE-LIST is a list of `package-desc' objects. |
| 1780 | Indirect dependencies are guaranteed to be returned in order only | 1780 | Indirect dependencies are guaranteed to be returned in order only |
| 1781 | if all the in-between dependencies are also in PACKAGE-LIST." | 1781 | if all the in-between dependencies are also in PACKAGE-LIST." |
| 1782 | (let ((alist (mapcar (lambda (p) (cons (package-desc-name p) p)) package-list)) | 1782 | (let ((alist (mapcar (lambda (p) (cons (package-desc-name p) p)) package-list)) |
| @@ -1845,11 +1845,11 @@ if all the in-between dependencies are also in PACKAGE-LIST." | |||
| 1845 | (setf (package-desc-signed (car pkg-descs)) t)))))))))) | 1845 | (setf (package-desc-signed (car pkg-descs)) t)))))))))) |
| 1846 | 1846 | ||
| 1847 | (defun package-installed-p (package &optional min-version) | 1847 | (defun package-installed-p (package &optional min-version) |
| 1848 | "Return true if PACKAGE, of MIN-VERSION or newer, is installed. | 1848 | "Return non-nil if PACKAGE, of MIN-VERSION or newer, is installed. |
| 1849 | If PACKAGE is a symbol, it is the package name and MIN-VERSION | 1849 | If PACKAGE is a symbol, it is the package name and MIN-VERSION |
| 1850 | should be a version list. | 1850 | should be a version list. |
| 1851 | 1851 | ||
| 1852 | If PACKAGE is a package-desc object, MIN-VERSION is ignored." | 1852 | If PACKAGE is a `package-desc' object, MIN-VERSION is ignored." |
| 1853 | (unless package--initialized (error "package.el is not yet initialized!")) | 1853 | (unless package--initialized (error "package.el is not yet initialized!")) |
| 1854 | (if (package-desc-p package) | 1854 | (if (package-desc-p package) |
| 1855 | (let ((dir (package-desc-dir package))) | 1855 | (let ((dir (package-desc-dir package))) |
| @@ -1865,7 +1865,7 @@ If PACKAGE is a package-desc object, MIN-VERSION is ignored." | |||
| 1865 | 1865 | ||
| 1866 | (defun package-download-transaction (packages) | 1866 | (defun package-download-transaction (packages) |
| 1867 | "Download and install all the packages in PACKAGES. | 1867 | "Download and install all the packages in PACKAGES. |
| 1868 | PACKAGES should be a list of package-desc. | 1868 | PACKAGES should be a list of `package-desc'. |
| 1869 | This function assumes that all package requirements in | 1869 | This function assumes that all package requirements in |
| 1870 | PACKAGES are satisfied, i.e. that PACKAGES is computed | 1870 | PACKAGES are satisfied, i.e. that PACKAGES is computed |
| 1871 | using `package-compute-transaction'." | 1871 | using `package-compute-transaction'." |
| @@ -1932,13 +1932,13 @@ add a call to it along with some explanatory comments." | |||
| 1932 | ;;;###autoload | 1932 | ;;;###autoload |
| 1933 | (defun package-install (pkg &optional dont-select) | 1933 | (defun package-install (pkg &optional dont-select) |
| 1934 | "Install the package PKG. | 1934 | "Install the package PKG. |
| 1935 | PKG can be a package-desc or a symbol naming one of the available packages | 1935 | PKG can be a `package-desc' or a symbol naming one of the available packages |
| 1936 | in an archive in `package-archives'. Interactively, prompt for its name. | 1936 | in an archive in `package-archives'. Interactively, prompt for its name. |
| 1937 | 1937 | ||
| 1938 | If called interactively or if DONT-SELECT nil, add PKG to | 1938 | If called interactively or if DONT-SELECT nil, add PKG to |
| 1939 | `package-selected-packages'. | 1939 | `package-selected-packages'. |
| 1940 | 1940 | ||
| 1941 | If PKG is a package-desc and it is already installed, don't try | 1941 | If PKG is a `package-desc' and it is already installed, don't try |
| 1942 | to install it but still mark it as selected." | 1942 | to install it but still mark it as selected." |
| 1943 | (interactive | 1943 | (interactive |
| 1944 | (progn | 1944 | (progn |
| @@ -2067,7 +2067,7 @@ If some packages are not installed propose to install them." | |||
| 2067 | 2067 | ||
| 2068 | ;;; Package Deletion | 2068 | ;;; Package Deletion |
| 2069 | (defun package--newest-p (pkg) | 2069 | (defun package--newest-p (pkg) |
| 2070 | "Return t if PKG is the newest package with its name." | 2070 | "Return non-nil if PKG is the newest package with its name." |
| 2071 | (equal (cadr (assq (package-desc-name pkg) package-alist)) | 2071 | (equal (cadr (assq (package-desc-name pkg) package-alist)) |
| 2072 | pkg)) | 2072 | pkg)) |
| 2073 | 2073 | ||
| @@ -2142,7 +2142,7 @@ If NOSAVE is non-nil, the package is not removed from | |||
| 2142 | ;;;###autoload | 2142 | ;;;###autoload |
| 2143 | (defun package-reinstall (pkg) | 2143 | (defun package-reinstall (pkg) |
| 2144 | "Reinstall package PKG. | 2144 | "Reinstall package PKG. |
| 2145 | PKG should be either a symbol, the package name, or a package-desc | 2145 | PKG should be either a symbol, the package name, or a `package-desc' |
| 2146 | object." | 2146 | object." |
| 2147 | (interactive (list (intern (completing-read | 2147 | (interactive (list (intern (completing-read |
| 2148 | "Reinstall package: " | 2148 | "Reinstall package: " |
| @@ -2567,7 +2567,7 @@ package PKG-DESC, add one. The alist is keyed with PKG-DESC." | |||
| 2567 | 2567 | ||
| 2568 | (defun package--incompatible-p (pkg &optional shallow) | 2568 | (defun package--incompatible-p (pkg &optional shallow) |
| 2569 | "Return non-nil if PKG has no chance of being installable. | 2569 | "Return non-nil if PKG has no chance of being installable. |
| 2570 | PKG is a package-desc object. | 2570 | PKG is a `package-desc' object. |
| 2571 | 2571 | ||
| 2572 | If SHALLOW is non-nil, this only checks if PKG depends on a | 2572 | If SHALLOW is non-nil, this only checks if PKG depends on a |
| 2573 | higher `emacs-version' than the one being used. Otherwise, also | 2573 | higher `emacs-version' than the one being used. Otherwise, also |
| @@ -2651,7 +2651,7 @@ Installed obsolete packages are always displayed.") | |||
| 2651 | 2651 | ||
| 2652 | (defun package--remove-hidden (pkg-list) | 2652 | (defun package--remove-hidden (pkg-list) |
| 2653 | "Filter PKG-LIST according to `package-archive-priorities'. | 2653 | "Filter PKG-LIST according to `package-archive-priorities'. |
| 2654 | PKG-LIST must be a list of package-desc objects, all with the | 2654 | PKG-LIST must be a list of `package-desc' objects, all with the |
| 2655 | same name, sorted by decreasing `package-desc-priority-version'. | 2655 | same name, sorted by decreasing `package-desc-priority-version'. |
| 2656 | Return a list of packages tied for the highest priority according | 2656 | Return a list of packages tied for the highest priority according |
| 2657 | to their archives." | 2657 | to their archives." |
| @@ -2905,7 +2905,7 @@ Return (PKG-DESC [NAME VERSION STATUS DOC])." | |||
| 2905 | ;;; Package menu printing | 2905 | ;;; Package menu printing |
| 2906 | (defun package-menu--print-info-simple (pkg) | 2906 | (defun package-menu--print-info-simple (pkg) |
| 2907 | "Return a package entry suitable for `tabulated-list-entries'. | 2907 | "Return a package entry suitable for `tabulated-list-entries'. |
| 2908 | PKG is a package-desc object. | 2908 | PKG is a `package-desc' object. |
| 2909 | Return (PKG-DESC [NAME VERSION STATUS DOC])." | 2909 | Return (PKG-DESC [NAME VERSION STATUS DOC])." |
| 2910 | (let* ((status (package-desc-status pkg)) | 2910 | (let* ((status (package-desc-status pkg)) |
| 2911 | (face (pcase status | 2911 | (face (pcase status |