Deduplicate, reorder displayException impl
#36
Merged
Conversation
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
The default `displayException = show` implementation is often used, leading to duplicated output in the `AnnotatedException` `displayException` implementation. Here we make a couple tweaks to that implementation: 1. If `show` and `displayException` return the same output, only one is used. 2. If only the `displayException` output is shown, it's not indented. 3. If both the `displayException` and `show` output is shown, the `displayException` output is shown first. 4. There is a blank line before the "Annotations:" section, to match the blank line between the `displayException` and `show` output. 5. There is a blank line before the call stack section.
9999years
commented
Apr 8, 2025
| callStackMessage = | ||
| [ "" |
There was a problem hiding this comment.
Extra newline before the callstack section to match the newline between the displayException and show sections.
9999years
commented
Apr 8, 2025
| anns -> | ||
| "Annotations:\n" | ||
| <> unlines (map (\ann -> "\t * " <> show ann) anns) | ||
| [ "" |
There was a problem hiding this comment.
Extra newline before the "Annotations:" section to match the newline between the displayException and show sections.
9999years
added a commit
to 9999years/annotated-exception
that referenced
this pull request
Apr 11, 2025
In parsonsmatt#36, I restructured the `AnnotatedException` `displayException` implementation so that instead of being of the form: displayException = unlines [ ... ] <> callStackMessage where callStackMessage = prettyCallStack frames It was of the form: displayException = unlines $ [ ... ] <> callStackMessage where callStackMessage = [prettyCallStack frames] I didn't realize that `unlines` adds a trailing newline, which is generally the wrong behavior for `displayException` instances. This change replaces `unlines` with `concat . intersperse "\n"` in order to regain the correct behavior.
6 tasks
parsonsmatt
pushed a commit
that referenced
this pull request
Apr 11, 2025
* displayException: Remove trailing newline In #36, I restructured the `AnnotatedException` `displayException` implementation so that instead of being of the form: displayException = unlines [ ... ] <> callStackMessage where callStackMessage = prettyCallStack frames It was of the form: displayException = unlines $ [ ... ] <> callStackMessage where callStackMessage = [prettyCallStack frames] I didn't realize that `unlines` adds a trailing newline, which is generally the wrong behavior for `displayException` instances. This change replaces `unlines` with `concat . intersperse "\n"` in order to regain the correct behavior. * 0.3.0.3 -> 0.3.0.4
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.
The default
displayException = showimplementation is often used, leading to duplicated output in theAnnotatedExceptiondisplayExceptionimplementation.Here we make a couple tweaks to that implementation:
showanddisplayExceptionreturn the same output, only one is used.displayExceptionoutput is shown, it's not indented.displayExceptionandshowoutput is shown, thedisplayExceptionoutput is shown first.displayExceptionandshowoutput.Before submitting your PR, check that you've:
@sincedeclarations to the Haddock.stylish-haskelland otherwise adhered to the style guide.After submitting your PR: