Fix doctest warning #14
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
Since Elixir 1.17, `iex> a < b` in the docteset emitted a warning. The workaround to hide the offending code from the compiler is too distracting. My solution is to move that code into an info block and explain things in words.
This is just some bad code. A linter would've caught this.
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.
Since Elixir 1.17 this code was generating a warning:
compare_chain/lib/compare_chain.ex
Lines 140 to 146 in 7acb340
Specifically,
a < bgenerates a warning about comparing structs. This is not unexpected (it's the whole point ofCompareChainafter all). But there isn't a good way to circumvent the warning. See the discussion here:https://elixirforum.com/t/elixir-v1-18-0-rc-0-released/68015/36
This PR works around the issue by removing that code and instead explaining what's going on in an info block:
I also tacked on a small refactor.