Limited doc update for info op #901
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
(arglists-str, file, line, column, name, ns)
Sample CIDER response
(-->
id "18"
op "info"
session "cdbe8f64-e972-482c-9677-9ae456aaae96"
time-stamp "2024-09-17 18:59:41.733894000"
ns "b"
sym "a/abc"
)
(<--
id "18"
session "cdbe8f64-e972-482c-9677-9ae456aaae96"
time-stamp "2024-09-17 18:59:41.736375000"
arglists-str "[]"
column 1
file "file:/D:/dev/clj/issue-cider-info/src/a.clj"
line 3
name "abc"
ns "a"
resource "a.clj"
status ("done")
)
ikappaki
force-pushed
the
doc/info-file-kw-update
branch
from
9b72452
to
3a2a24a
Compare
bbatsov
reviewed
Sep 18, 2024
ikappaki
force-pushed
the
doc/info-file-kw-update
branch
from
12aa82d
to
e9140a2
Compare
|
thanks @bbatsov! Is it possible to regenerate the latest docs at https://docs.cider.mx/cider-nrepl/, or is it tied to the latest release? |
|
@ikappaki Done. (it's a manual process) |
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.
Hi,
could you please review patch to do limited upated to the
infoop documentation. It partially addresses #885, specifically #885 (comment).There are no functional changes. This update provides a reference for the basic usage of
info, particularly clarifying that thefilereturn key value should be either a URI or a relative path.The new descriptions were determined empirically by examining log messages in CIDER. I'm open to corrections.
(Note: An unexpected
expanderentry appeared in the generated ops doc, which seems to have been missed in #894.)Thanks
Before submitting a PR make sure the following things have been done:
cider.nreplns which has all middleware documentation.lein docsafterwards, and commit the results.Note: If you're just starting out to hack on
cider-nreplyou might findnREPL's documentation and the
"Design" section of the README extremely useful.*
Thanks!