Skip to content
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.

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

Document better the lookup middleware return values #257

Open
bbatsov opened this issue Nov 14, 2021 · 2 comments
Open

Document better the lookup middleware return values #257

bbatsov opened this issue Nov 14, 2021 · 2 comments
Labels
Documentation Good First Issue Simple tasks that would be a good choice for newcomers

Comments

@bbatsov
Copy link
Contributor

bbatsov commented Nov 14, 2021

A follow-up to a comment made by @plexus.

Basically, we need to document precisely:

  • all possible return keys
  • what each key signifies

As a reminder, this is still an experimental op and it's subject to changes. Same with completions.

@bbatsov
Copy link
Contributor Author

bbatsov commented Nov 14, 2021

For reference - here's the existing documentation https://nrepl.org/nrepl/0.8/usage/misc.html#symbol-lookup

Normally, this would be in the https://nrepl.org/nrepl/0.8/ops.html section, but it's a bit hard to have a lot of info there, as this is generated from the middleware descriptors.

@bbatsov bbatsov added the Good First Issue Simple tasks that would be a good choice for newcomers label Aug 25, 2022
@bbatsov
Copy link
Contributor Author

bbatsov commented Aug 25, 2022

There's more on the subject here #275 (comment)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Documentation Good First Issue Simple tasks that would be a good choice for newcomers
Projects
None yet
Development

No branches or pull requests

1 participant