Skip to content

Extended documentation string of quickload #239

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 6 commits into
base: master
Choose a base branch
from
Open

Extended documentation string of quickload #239

Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
8e2185b
Extended documentation string of quickload
NicoSimoski Apr 29, 2025
a159a7d
Extended documentation string of QUICKLOAD
NicoSimoski Apr 29, 2025
4c30306
Extended documentation string of QUICKLOAD
NicoSimoski Apr 29, 2025
5c86aeb
Improved documentation string for arguments of QUICKLOAD
NicoSimoski Apr 29, 2025
1755253
Added missing point to docstring
NicoSimoski Apr 29, 2025
8fe9c5f
Removed examples and reworked explanations in docstring of QUICKLOAD
NicoSimoski May 12, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 22 additions & 2 deletions quicklisp/client.lisp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,8 +22,28 @@

(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.")
"Load SYSTEMS the quicklisp way.

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 lower case 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 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.
The default is NIL.
:EXPLAIN
is not used in the default method.

QUICKLOAD will return SYSTEMS.
")
(:method (systems &key
(prompt *quickload-prompt*)
(silent nil)
Expand Down