@@ -43,29 +43,28 @@ in QL-META.")
43
43
(dist-url dist)))
44
44
45
45
(defun dist-properties (dist)
46
- " DIST-PROPERTIES yields the list of properties of a DIST."
46
+ " DIST-PROPERTIES returns the list of properties of a DIST."
47
47
(cadr dist))
48
48
49
49
50
50
(defun dist-url (dist)
51
- " DIST-URL yields the url property of a DIST"
51
+ " DIST-URL returns the url property of a DIST"
52
52
(getf (dist-properties dist) :url ))
53
53
54
54
55
55
(defun get-dist (dist-name)
56
- " GET-DIST retrieves a DIST based on DIST-NAME, if existing. Otherwise,
57
- yields NIL."
56
+ " GET-DIST retrieves a DIST based on DIST-NAME, if existing. Otherwise, returns NIL."
58
57
(assoc (%dist-id dist-name)
59
58
*dists* ))
60
59
61
60
(defun get-dists-urls (&optional (dists *dists* ))
62
- " GET-DISTS-URLS yields a list of all dist urls defined in *DISTS*"
61
+ " GET-DISTS-URLS returns a list of all dist urls defined in *DISTS*. "
63
62
(loop for dist in dists
64
63
collect (dist-url dist)))
65
64
66
65
67
66
(defun get-dists-names (&optional (dists *dists* ))
68
- " GET-DISTS-NAMES yields a list of all dist names defined in *DISTS*"
67
+ " GET-DISTS-NAMES returns a list of all dist names defined in *DISTS*"
69
68
(loop for (key plist) in dists
70
69
collect key))
71
70
@@ -75,7 +74,7 @@ yields NIL."
75
74
(and dist-obj (ql-dist :installedp dist-obj))))
76
75
77
76
(defun install-dist (dist-name &key (force nil ))
78
- " INSTALL-DIST a dist DIST-NAME using QL-DIST.
77
+ " INSTALL-DIST installs a dist DIST-NAME using QL-DIST.
79
78
80
79
As default, use the parameters (:prompt nil :replace t) on
81
80
ql-dist:install-dist to avoid human interaction.
@@ -94,8 +93,8 @@ raises an error."
94
93
(defun uninstall-dist (dist-name)
95
94
" UNINSTALL-DIST a dist DIST-NAME using QL-DIST.
96
95
97
- Yields NIL on uninstallation error and when the dist DIST-NAME were not
98
- installed in the first place. Otherwise, yields T."
96
+ Returns NIL on uninstallation error and when the dist DIST-NAME were not
97
+ installed in the first place. Otherwise, returns T."
99
98
(let ((dist (get-dist dist-name)))
100
99
(when (and dist (installedp dist))
101
100
(let* ((dist-obj (ql-dist :find-dist (%dist-realname dist))))
@@ -120,7 +119,7 @@ Specifying SILENT suppresses output."
120
119
121
120
(defgeneric dist-apropos-list (term)
122
121
(:documentation
123
- " DIST-APROPOS-LIST yields a list of DISTs based in a matching TERM.
122
+ " DIST-APROPOS-LIST returns a list of DISTs based in a matching TERM.
124
123
125
124
This function considers %dist-realname and dist-url when searching." )
126
125
(:method ((term symbol ))
@@ -137,8 +136,7 @@ This function considers %dist-realname and dist-url when searching.")
137
136
138
137
(defgeneric dist-apropos (term)
139
138
(:documentation
140
- " DIST-APROPOS searches for a dist containing TERM and prints it to
141
- *STANDARD-OUTPUT*.
139
+ " DIST-APROPOS searches for a dist containing TERM and prints it to *STANDARD-OUTPUT*.
142
140
143
141
This function effectively wraps DIST-APROPOS-LIST so it is printed nicely on
144
142
console." )
0 commit comments