Fix IEx doc printing for headings with newline characters #13018
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
Update `IEx.introspection.print_doc/5` to trasverse the list of headings and split each heading into multiple headings, in case the heading has any newline characters (`\n`). This fixes an issue where using the `h` macro with some functions ended up with a broken output for the function signature, as the padding done by `IO.ANSI.Docs.print_headings/2` does not take into consideration the fact the the headings can contain newline characters, and thus end up in multiple lines.
dinocosta
commented
Oct 18, 2023
josevalim
reviewed
Oct 18, 2023
- Move the fix for headings with newline characters from `IEx.Introspection.print_doc/5` to `IO.ANSI.Docs.print_headings/1,2`. - Apply suggestion to use `Enum.flat_map/2` over `Enum.map/2` followed by `Enum.flatten/1`. - Create new test case to make sure `IO.ANSI.Docs.print_headings` correctly formats headings with newline 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.
Update
IEx.introspection.print_doc/5to trasverse the list of headings and split each heading into multiple headings, in case the heading has any newline characters (\n). This fixes an issue where using thehmacro with some functions ended up with a broken output for the function signature, as the padding done byIO.ANSI.Docs.print_headings/2does not take into consideration the fact the the headings can contain newline characters, and thus end up in multiple lines.Here's a before and after comparison of running
h dbginiex:Before
After