Add docstrings to matcher-combinators.test declarations#236
Open
philomates wants to merge 1 commit intomasterfrom
Open
Add docstrings to matcher-combinators.test declarations#236philomates wants to merge 1 commit intomasterfrom
philomates wants to merge 1 commit intomasterfrom
Conversation
33d00a3 to
1fef66d
Compare
teodorlu
reviewed
Apr 13, 2026
Comment on lines
+32
to
+36
| (defn match-with? | ||
| "DEPRECATED: Use (match? (matcher-combinators.matchers/match-with <type->matcher> <expected>) <actual>) instead." | ||
| [type->matcher matcher actual] | ||
| (throw (#?(:cljs js/Error. :clj AssertionError.) | ||
| "Should only be invoked within a `clojure.test/is` form"))) |
There was a problem hiding this comment.
Could also be helpful for users to include :deprecated "deprecated-version" metadata:
Suggested change
| (defn match-with? | |
| "DEPRECATED: Use (match? (matcher-combinators.matchers/match-with <type->matcher> <expected>) <actual>) instead." | |
| [type->matcher matcher actual] | |
| (throw (#?(:cljs js/Error. :clj AssertionError.) | |
| "Should only be invoked within a `clojure.test/is` form"))) | |
| (defn match-with? | |
| "DEPRECATED: Use (match? (matcher-combinators.matchers/match-with <type->matcher> <expected>) <actual>) instead." | |
| {:deprecated "3.0.0"} | |
| [type->matcher matcher actual] | |
| (throw (#?(:cljs js/Error. :clj AssertionError.) | |
| "Should only be invoked within a `clojure.test/is` form"))) |
This will show up in most editors that rely on clojure-lsp. My Emacs the referenced var with strikethough, and deprecated version below:
|
Looks like this is a redo of my PR #207, which i couldn't ever get to work. I'll close that one if you can get the test suite to pass. |
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
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.
I had to change the
declareforms inmatcher-combinators.testtodefns so that the docstring would be picked up by LSP. Just adding:docmeta to the declare, like the following, doesn't seem to get picked up by the clojure LSP as far as I can tell