Set up DoctestFormatter #427
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
| @@ -18,37 +18,39 @@ defmodule Benchee.Conversion do | |||
| ## Examples | |||
|
|
|||
| iex> statistics = %Benchee.Statistics{average: 1_000_000.0, ips: 1000.0} | |||
| iex> scenario = %Benchee.Scenario{ | |||
| ...> | |||
There was a problem hiding this comment.
Every iex> prompt that is not the first line of the test, will get changed to ...>. This is not strictly necessary, but it's recommended by the official docs:
Multiline expressions can be used by prefixing subsequent lines with either ...> (recommended) or iex>.
|
This is omega nice! Mega Dzieki! I'm traveling right now, I'll fix the damn macos build and then merge the MR 😅 I looked the changes over and it's exactly what I was looking for, this is amazing work thank you very much!
|
|
Thanks a lot @angelikatyborska ! |
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.
This PR sets up a formatter plugin that deals with doctests, https://hexdocs.pm/doctest_formatter/readme.html
The plugin formats Elixir code in the test according to the rules that apply to the rest of the codebase, and also makes the
iex>prompts consistent.Disclaimer: I'm the author of the plugin, and the plugin was written based on @PragTob's suggestion 🙂