Minor adjustments to docstrings #3706
Merged
Conversation
This file contains 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
bbatsov
reviewed
Jun 8, 2024
cider-client.el
Outdated
| @@ -548,7 +548,7 @@ Used only when the info nREPL middleware is not available." | |||
| var-info)) | |||
|
|
|||
| (defun cider-var-info (var &optional all) | |||
| "Return VAR's info as an alist with list cdrs. | |||
| "Return info on VAR as an nREPL dict. | |||
bbatsov
reviewed
Jun 8, 2024
cider-client.el
Outdated
| @@ -559,7 +559,7 @@ unless ALL is truthy." | |||
| (if all var-info (cider--var-choice var-info))))) | |||
|
|
|||
| (defun cider-member-info (class member) | |||
| "Return the CLASS MEMBER's info as an alist with list cdrs." | |||
| "Return info on MEMBER of CLASS as an nREPL dict." | |||
|
@bbatsov I've applied the suggested changes. |
|
Thanks! |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Tweak docstring of
cider-sync-request:clojuredocs-lookupas it actually performsclojuredocs-lookupop and notresourceop.Tweak docstrings of
cider-var-infoandcider-member-infoas it seems that what these functions actually return is an nREPL dict and not an alist. Also, I'm not sure what "with list cdrs" means.