Extended documentation string of quickload #239
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
- Added defaults for arguments - Added example calls
- Added types of arguments
- changed types of SYSTEMS to bullet points
Owner
|
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:
#239
Commit Summary
- 8e2185b
<8e2185b>
Extended documentation string of quickload
- a159a7d
<a159a7d>
Extended documentation string of QUICKLOAD
- 4c30306
<4c30306>
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
<#239>, or unsubscribe
<https://github.com/notifications/unsubscribe-auth/AACPNLKCIBFDINFL5VUWCOT235NT5AVCNFSM6AAAAAB4CTEUK6VHI2DSMVQWIX3LMV43ASLTON2WKOZTGAZDONZUGI2TOMQ>
.
You are receiving this because you are subscribed to this thread.Message
ID: ***@***.***>
|
Author
|
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. |
Author
|
Hello! :-) I removed the examples and tried to adapt the style of the docstring of SB-EXT:RUN-COMMAND. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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.