quicklisp-client
quicklisp-client copied to clipboard
quicklisp
Extended documentation string of quickload
- Added defaults for arguments
- Added example calls
Hello! :-)
I'm really interested in helping to improve quicklisp and read everything I could find about it. I found your ELS talk how to get beyond beta and would like to improve the documentation of the user commands. Here's a first draft for QUICKLOAD. How can I improve the draft?
On a side note: I found out that the argument EXPLAIN is not used in the default method.
I don't think examples like that have a place in docstrings, and it's not very useful to simply list the arguments and their types and defaults. Their meaning and behavior is better. See the docstring for sb-ext:run-program for something I consider pretty good.
On Tue, Apr 29, 2025 at 7:17 AM NicoSimoski @.***> wrote:
- Added defaults for arguments
- Added example calls
Hello! :-)
I'm really interested in helping to improve quicklisp and read everything I could find about it. I found your ELS talk how to get beyond beta and would like to improve the documentation of the user commands. Here's a first draft for QUICKLOAD. How can I improve the draft?
On a side note: I found out that the argument EXPLAIN is not used in the default method.
You can view, comment on, or merge this pull request online at:
https://github.com/quicklisp/quicklisp-client/pull/239 Commit Summary
- 8e2185b https://github.com/quicklisp/quicklisp-client/pull/239/commits/8e2185ba9b723e2cad37d0635c2b7603292ccdbd Extended documentation string of quickload
- a159a7d https://github.com/quicklisp/quicklisp-client/pull/239/commits/a159a7d726b82ad05afb3016ce2c827136a3d9a1 Extended documentation string of QUICKLOAD
- 4c30306 https://github.com/quicklisp/quicklisp-client/pull/239/commits/4c30306c4bec4ac5e90138f46291dbce3eccfdd5 Extended documentation string of QUICKLOAD
File Changes
(1 file https://github.com/quicklisp/quicklisp-client/pull/239/files)
- M quicklisp/client.lisp https://github.com/quicklisp/quicklisp-client/pull/239/files#diff-52c9d7a97258d927a830266b98cbbe384ff27e72db93bd6408f77c39b28c3adf (34)
Patch Links:
- https://github.com/quicklisp/quicklisp-client/pull/239.patch
- https://github.com/quicklisp/quicklisp-client/pull/239.diff
— Reply to this email directly, view it on GitHub https://github.com/quicklisp/quicklisp-client/pull/239, or unsubscribe https://github.com/notifications/unsubscribe-auth/AACPNLKCIBFDINFL5VUWCOT235NT5AVCNFSM6AAAAAB4CTEUK6VHI2DSMVQWIX3LMV43ASLTON2WKOZTGAZDONZUGI2TOMQ . You are receiving this because you are subscribed to this thread.Message ID: @.***>
Thanks, that's really a nice docstring! I will try to adapt it's style.
I included the examples because I know some programmers who consider a documentation bad if there are no examples.
Some of them don't even read anything else of the documentation.
And I liked the idea to get those examples when evaluating (describe 'ql:quickload).
Where would you put the examples?
Hello! :-)
I removed the examples and tried to adapt the style of the docstring of SB-EXT:RUN-COMMAND.