Skip to content

Commit 22a8354

Browse files
luksamukryukinix
authored andcommitted
Replace words on documentation to avoid confusion
1 parent 7bfc730 commit 22a8354

File tree

1 file changed

+10
-12
lines changed

1 file changed

+10
-12
lines changed

src/quicksys.lisp

+10-12
Original file line numberDiff line numberDiff line change
@@ -43,29 +43,28 @@ in QL-META.")
4343
(dist-url dist)))
4444

4545
(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."
4747
(cadr dist))
4848

4949

5050
(defun dist-url (dist)
51-
"DIST-URL yields the url property of a DIST"
51+
"DIST-URL returns the url property of a DIST"
5252
(getf (dist-properties dist) :url))
5353

5454

5555
(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."
5857
(assoc (%dist-id dist-name)
5958
*dists*))
6059

6160
(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*."
6362
(loop for dist in dists
6463
collect (dist-url dist)))
6564

6665

6766
(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*"
6968
(loop for (key plist) in dists
7069
collect key))
7170

@@ -75,7 +74,7 @@ yields NIL."
7574
(and dist-obj (ql-dist:installedp dist-obj))))
7675

7776
(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.
7978
8079
As default, use the parameters (:prompt nil :replace t) on
8180
ql-dist:install-dist to avoid human interaction.
@@ -94,8 +93,8 @@ raises an error."
9493
(defun uninstall-dist (dist-name)
9594
"UNINSTALL-DIST a dist DIST-NAME using QL-DIST.
9695
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."
9998
(let ((dist (get-dist dist-name)))
10099
(when (and dist (installedp dist))
101100
(let* ((dist-obj (ql-dist:find-dist (%dist-realname dist))))
@@ -120,7 +119,7 @@ Specifying SILENT suppresses output."
120119

121120
(defgeneric dist-apropos-list (term)
122121
(: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.
124123
125124
This function considers %dist-realname and dist-url when searching.")
126125
(:method ((term symbol))
@@ -137,8 +136,7 @@ This function considers %dist-realname and dist-url when searching.")
137136

138137
(defgeneric dist-apropos (term)
139138
(: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*.
142140
143141
This function effectively wraps DIST-APROPOS-LIST so it is printed nicely on
144142
console.")

0 commit comments

Comments
 (0)