From 8e2185ba9b723e2cad37d0635c2b7603292ccdbd Mon Sep 17 00:00:00 2001 From: Nico Simoski Date: Tue, 29 Apr 2025 11:47:44 +0200 Subject: [PATCH 1/6] Extended documentation string of quickload - Added defaults for arguments - Added example calls --- quicklisp/client.lisp | 29 ++++++++++++++++++++++++++++- 1 file changed, 28 insertions(+), 1 deletion(-) diff --git a/quicklisp/client.lisp b/quicklisp/client.lisp index 1fbf8b9..7148113 100644 --- a/quicklisp/client.lisp +++ b/quicklisp/client.lisp @@ -23,7 +23,34 @@ (defgeneric quickload (systems &key verbose silent prompt explain &allow-other-keys) (:documentation "Load SYSTEMS the quicklisp way. SYSTEMS is a designator for a list - of things to be loaded.") + of things to be loaded. + + VERBOSE defaults to NIL. + SILENT defaults to NIL. + PROMPT defaults to NIL. + EXPLAIN defaults to T but is not used in the default method. + + Examples: + + Load a single SYSTEM like ALEXANDRIA with + (ql:quickload \"alexandria\") + or + (ql:quickload :alexandria) + + Load multiple SYSTEMS like ALEXANDRIA and SERAPEUM with + (ql:quickload '(\"alexandria\" \"serapeum\")) + or + (ql:quickload '(:alexandria :serapeum)) + + Load SYSTEMS with verbose compilation (only dots are displayed otherwise to show the progress) + (ql:quickload :alexandria :verbose t) + + Load SYSTEMS suppressing output to *STANDARD-OUTPUT* + (ql:quickload :alexandria :silent t) + + Load SYSTEMS and get a prompt whether to continue + (ql:quickload :alexandria :prompt t) +") (:method (systems &key (prompt *quickload-prompt*) (silent nil) From a159a7d726b82ad05afb3016ce2c827136a3d9a1 Mon Sep 17 00:00:00 2001 From: Nico Simoski Date: Tue, 29 Apr 2025 12:21:46 +0200 Subject: [PATCH 2/6] Extended documentation string of QUICKLOAD - Added types of arguments --- quicklisp/client.lisp | 9 +++++---- 1 file changed, 5 insertions(+), 4 deletions(-) diff --git a/quicklisp/client.lisp b/quicklisp/client.lisp index 7148113..370a334 100644 --- a/quicklisp/client.lisp +++ b/quicklisp/client.lisp @@ -25,10 +25,11 @@ "Load SYSTEMS the quicklisp way. SYSTEMS is a designator for a list of things to be loaded. - VERBOSE defaults to NIL. - SILENT defaults to NIL. - PROMPT defaults to NIL. - EXPLAIN defaults to T but is not used in the default method. + SYSTEMS can be either a string, a keyword symbol, a list of strings or a list of keyword symbols. + VERBOSE is boolean and defaults to NIL. + SILENT is boolean and defaults to NIL. + PROMPT is boolean and defaults to NIL. + EXPLAIN is boolean and defaults to T but is not used in the default method. Examples: From 4c30306c4bec4ac5e90138f46291dbce3eccfdd5 Mon Sep 17 00:00:00 2001 From: Nico Simoski Date: Tue, 29 Apr 2025 12:23:41 +0200 Subject: [PATCH 3/6] Extended documentation string of QUICKLOAD - changed types of SYSTEMS to bullet points --- quicklisp/client.lisp | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/quicklisp/client.lisp b/quicklisp/client.lisp index 370a334..7aa53d4 100644 --- a/quicklisp/client.lisp +++ b/quicklisp/client.lisp @@ -25,7 +25,11 @@ "Load SYSTEMS the quicklisp way. SYSTEMS is a designator for a list of things to be loaded. - SYSTEMS can be either a string, a keyword symbol, a list of strings or a list of keyword symbols. + SYSTEMS can be either + - a string, + - a keyword symbol, + - a list of strings or + - a list of keyword symbols. VERBOSE is boolean and defaults to NIL. SILENT is boolean and defaults to NIL. PROMPT is boolean and defaults to NIL. From 5c86aeb4c53bede65a3cd67bcda8a0384849a561 Mon Sep 17 00:00:00 2001 From: Nico Simoski Date: Tue, 29 Apr 2025 19:12:33 +0200 Subject: [PATCH 4/6] Improved documentation string for arguments of QUICKLOAD --- quicklisp/client.lisp | 75 ++++++++++++++++++++++++------------------- 1 file changed, 42 insertions(+), 33 deletions(-) diff --git a/quicklisp/client.lisp b/quicklisp/client.lisp index 7aa53d4..efe2c6a 100644 --- a/quicklisp/client.lisp +++ b/quicklisp/client.lisp @@ -22,39 +22,48 @@ (defgeneric quickload (systems &key verbose silent prompt explain &allow-other-keys) (:documentation - "Load SYSTEMS the quicklisp way. SYSTEMS is a designator for a list - of things to be loaded. - - SYSTEMS can be either - - a string, - - a keyword symbol, - - a list of strings or - - a list of keyword symbols. - VERBOSE is boolean and defaults to NIL. - SILENT is boolean and defaults to NIL. - PROMPT is boolean and defaults to NIL. - EXPLAIN is boolean and defaults to T but is not used in the default method. - - Examples: - - Load a single SYSTEM like ALEXANDRIA with - (ql:quickload \"alexandria\") - or - (ql:quickload :alexandria) - - Load multiple SYSTEMS like ALEXANDRIA and SERAPEUM with - (ql:quickload '(\"alexandria\" \"serapeum\")) - or - (ql:quickload '(:alexandria :serapeum)) - - Load SYSTEMS with verbose compilation (only dots are displayed otherwise to show the progress) - (ql:quickload :alexandria :verbose t) - - Load SYSTEMS suppressing output to *STANDARD-OUTPUT* - (ql:quickload :alexandria :silent t) - - Load SYSTEMS and get a prompt whether to continue - (ql:quickload :alexandria :prompt t) + "Load SYSTEMS the quicklisp way. + + QUICKLOAD will return SYSTEMS. + + SYSTEMS is a designator for a list of systems to be loaded. + It can also be a designator for a single system. + A valid designator for a system is either a string or a keyword symbol + + The &KEY arguments have the following meanings: + :VERBOSE + If non-NIL SYSTEMS will be compiled verbose if they weren't compiled before. + Otherwise dots are displayed to show compilation progress. + The default is NIL. + :SILENT + If non-NIL writing to *STANDARD-OUTPUT* is prohibited. + The default is NIL. + :PROMPT + If non-NIL the user is prompted to continue loading the SYSTEMS by hitting enter for each system. + The default is NIL. + :EXPLAIN + is not used in the default method. + + Examples: + + Load a single SYSTEM like ALEXANDRIA with + (ql:quickload \"alexandria\") + or + (ql:quickload :alexandria) + + Load multiple SYSTEMS like ALEXANDRIA and SERAPEUM with + (ql:quickload '(\"alexandria\" \"serapeum\")) + or + (ql:quickload '(:alexandria :serapeum)) + + Load SYSTEMS with verbose compilation (only dots are displayed otherwise to show the progress) + (ql:quickload :alexandria :verbose t) + + Load SYSTEMS suppressing output to *STANDARD-OUTPUT* + (ql:quickload :alexandria :silent t) + + Load SYSTEMS and get a prompt whether to continue + (ql:quickload :alexandria :prompt t) ") (:method (systems &key (prompt *quickload-prompt*) From 17552533a57671845884eaa23ed2af50856421f2 Mon Sep 17 00:00:00 2001 From: Nico Simoski Date: Tue, 29 Apr 2025 19:15:38 +0200 Subject: [PATCH 5/6] Added missing point to docstring --- quicklisp/client.lisp | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/quicklisp/client.lisp b/quicklisp/client.lisp index efe2c6a..778d805 100644 --- a/quicklisp/client.lisp +++ b/quicklisp/client.lisp @@ -28,7 +28,7 @@ SYSTEMS is a designator for a list of systems to be loaded. It can also be a designator for a single system. - A valid designator for a system is either a string or a keyword symbol + A valid designator for a system is either a string or a keyword symbol. The &KEY arguments have the following meanings: :VERBOSE From 8fe9c5fe1f19ec357530deb481149f663f641211 Mon Sep 17 00:00:00 2001 From: Nico Simoski Date: Mon, 12 May 2025 11:39:57 +0200 Subject: [PATCH 6/6] Removed examples and reworked explanations in docstring of QUICKLOAD --- quicklisp/client.lisp | 29 ++++------------------------- 1 file changed, 4 insertions(+), 25 deletions(-) diff --git a/quicklisp/client.lisp b/quicklisp/client.lisp index 778d805..6c1257a 100644 --- a/quicklisp/client.lisp +++ b/quicklisp/client.lisp @@ -24,11 +24,9 @@ (:documentation "Load SYSTEMS the quicklisp way. - QUICKLOAD will return SYSTEMS. - - SYSTEMS is a designator for a list of systems to be loaded. + SYSTEMS is list of designators for systems to be loaded. It can also be a designator for a single system. - A valid designator for a system is either a string or a keyword symbol. + A valid designator for a system is either a lower case string or a keyword symbol. The &KEY arguments have the following meanings: :VERBOSE @@ -36,7 +34,7 @@ Otherwise dots are displayed to show compilation progress. The default is NIL. :SILENT - If non-NIL writing to *STANDARD-OUTPUT* is prohibited. + If non-NIL QUICKLOAD doesn't output on *STANDARD-OUTPUT*. The default is NIL. :PROMPT If non-NIL the user is prompted to continue loading the SYSTEMS by hitting enter for each system. @@ -44,26 +42,7 @@ :EXPLAIN is not used in the default method. - Examples: - - Load a single SYSTEM like ALEXANDRIA with - (ql:quickload \"alexandria\") - or - (ql:quickload :alexandria) - - Load multiple SYSTEMS like ALEXANDRIA and SERAPEUM with - (ql:quickload '(\"alexandria\" \"serapeum\")) - or - (ql:quickload '(:alexandria :serapeum)) - - Load SYSTEMS with verbose compilation (only dots are displayed otherwise to show the progress) - (ql:quickload :alexandria :verbose t) - - Load SYSTEMS suppressing output to *STANDARD-OUTPUT* - (ql:quickload :alexandria :silent t) - - Load SYSTEMS and get a prompt whether to continue - (ql:quickload :alexandria :prompt t) + QUICKLOAD will return SYSTEMS. ") (:method (systems &key (prompt *quickload-prompt*)