Fix malformed h2 links #711
Conversation
|
Hello, @ScrimpyCat! This is your first Pull Request that will be reviewed by Ebert, an automatic Code Review service. It will leave comments on this diff with potential issues and style violations found in the code as you push new commits. You can also see all the issues found on this Pull Request on its review page. Please check our documentation for more information. |
| @@ -52,6 +52,25 @@ defmodule ExDoc.Formatter.HTML.TemplatesTest do | |||
| assert Templates.header_to_id("Git Options (<code class=\"inline\">:git</code>)") == "git-options-git" | |||
| end | |||
|
|
|||
| test "link headers" do | |||
| assert Templates.link_headings("<h2>Foo</h2><h2>Bar</h2>") == "<h2 id=\"foo\" class=\"section-heading\">\n <a href=\"#foo\" class=\"hover-link\"><i class=\"icon-link\"></i></a>\n Foo\n</h2>\n<h2 id=\"bar\" class=\"section-heading\">\n <a href=\"#bar\" class=\"hover-link\"><i class=\"icon-link\"></i></a>\n Bar\n</h2>\n" | |||
There was a problem hiding this comment.
Can you please break those over multiple lines and use escape characters? Like this:
assert Templates.link_headings("<h2>Foo</h2><h2>Bar</h2>") ==
~s[<h2 id="foo" class="section-heading">\n <a href="#foo" class="hover-link"><i class="icon-link"></i></a>\n Foo\n</h2>\n<h2 id="bar" class="section-heading">\n <a href="#bar" class="hover-link"><i class="icon-link"></i></a>\n Bar\n</h2>\n"
Or if you prefer:
assert Templates.link_headings("<h2>Foo</h2><h2>Bar</h2>") == """
<h2 id="foo" class="section-heading">
<a href="#foo" class="hover-link"><i class="icon-link"></i></a>
Foo
</h2>
<h2 id="bar" class="section-heading">
<a href="#bar" class="hover-link"><i class="icon-link"></i></a>
Bar
</h2>
"""There was a problem hiding this comment.
Sure, is there a preference between one or the other? If not I'll probably do the latter so it's easier to read.
There was a problem hiding this comment.
@ScrimpyCat whatever you prefer. :)
![sourcelevel-bot[bot]](https://avatars.githubusercontent.com/in/597?s=60&v=4){kind=small}
| Foo | ||
| </h2> | ||
| <h2></h2> | ||
| """ |> String.rstrip |
There was a problem hiding this comment.
More than 3 quotes found inside string literal, consider using a sigil instead.
| </h2> | ||
|
|
||
| <h2></h2> | ||
| """ |> String.rstrip |
There was a problem hiding this comment.
More than 3 quotes found inside string literal, consider using a sigil instead.
| </h2> | ||
|
|
||
| <h2></h2> | ||
| """ |> String.rstrip |
There was a problem hiding this comment.
Use a function call when a pipeline is only one function long
| Foo | ||
| </h2> | ||
| <h2></h2> | ||
| """ |> String.rstrip |
There was a problem hiding this comment.
Use a function call when a pipeline is only one function long
|
@josevalim If this all looks good, let me know if you want me to squish these changes. |
Fix for the malformed h2 links. Also added some tests for the link headings and sidebar items. Additional test cases might be desired?