Skip to content

Fix #3307: Incorrect special-form eldocs #3323

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

Closed
wants to merge 1 commit into from
Closed

Fix #3307: Incorrect special-form eldocs #3323

wants to merge 1 commit into from

Conversation

quanticle
Copy link
Contributor

@quanticle quanticle commented Feb 10, 2023

Fix #3307: Incorrect special-form eldocs

This fix is the CIDER companion to this PR in orchard, which lets us know if the symbol we're querying eldocs for is a special form or an ordinary function.

This change uses that information to deduplicate the arglists for the special form. In the process, the change adds a
cider-eldoc-format-special-form function, which serves as a home for special form formatting.


Before submitting the PR make sure the following things have been done (and denote this
by checking the relevant checkboxes):

  • The commits are consistent with our contribution guidelines
  • You've added tests (if possible) to cover your change(s)
  • All tests are passing (eldev test)
  • All code passes the linter (eldev lint) which is based on elisp-lint and includes
  • You've updated the changelog (if adding/changing user-visible functionality)
  • You've updated the user manual (if adding/changing user-visible functionality)

This fix is the CIDER companion to [this
PR](clojure-emacs/orchard#166) in orchard,
which lets us know if the symbol we're querying eldocs for is a
special form or an ordinary function.

This changes uses that information to deduplicate the arglists for the
special form. In the process, the change adds a
`cider-eldoc-format-special-form` function, which serves as a home for
special form formatting.

This change also adds a unit test for cider-eldoc to ensure that it
calls the appropriate formatting methods.
Copy link
Member

@vemv vemv left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks reasonable!

Some suggestions.

@bbatsov
Copy link
Member

bbatsov commented Feb 27, 2023

You'll also have to rebase on top of master to resolve the changelog conflict.

@bbatsov
Copy link
Member

bbatsov commented Mar 9, 2023

@quanticle ping :-)

@bbatsov
Copy link
Member

bbatsov commented Mar 25, 2023

@quanticle Ping 2 :-)

@bbatsov
Copy link
Member

bbatsov commented Jun 8, 2023

@vemv As you had some small suggestion do you want to drive this PR to the finish line? Alternatively I can just merge it as is.

@vemv
Copy link
Member

vemv commented Jun 8, 2023

Yep - saving it for the weekend then 👍

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Documentation highlighting appears to be incorrect for special forms
3 participants