Try fixing a bug in apropos
#130
Merged
+48
−19
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
vemv
commented
Sep 24, 2021
| (defn- default-comparator [ns clojure-ns?] | ||
| (fn [x y] | ||
| (cond | ||
| (= x y) 0 |
There was a problem hiding this comment.
Added a (= x y) 0 clause making the sort stable.
Unfortunately I couldn't prove this fixes the issue, however it's most likely an improvement.
| ;; Don't accept this exception in our CI - we should fix this if it's reproducible. | ||
| (throw e)) | ||
| ;; Fallback to a simpler comparator: | ||
| (sort-by key-fn safe-comparator vars))))) |
There was a problem hiding this comment.
Added a fallback so that this feature doesn't fail altogether due to something relatively unimportant such as sorting.
| [orchard.meta :refer [var-name var-doc]])) | ||
|
|
||
| (def ^{:doc "Test1. Test2. Test3."} public-var [1 2 3]) | ||
|
|
||
| (defn some-random-function []) | ||
|
|
||
| (deftest apropos-sort-test |
There was a problem hiding this comment.
Added some extra tests, they passed before the fix anyway.
#128 seems hard to repro since apropos results depend on ones's classpath.
|
The proposed fix seems good to me. |
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.
See #128
Tries fixing the bug itself, and also introduces a fallback. Will comment inline.