Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP

Loading…

span span span span #122

Open
TrevorBramble opened this Issue · 4 comments

3 participants

@TrevorBramble

Somehow I'm screwing this up. When I go to update the docs to take into account a change in the reloader library, its page has all this extra markup in it now.

My commit seems innocent. sinatra/sinatra-contrib@49808be

Any ideas?

-<h1>Sinatra::Reloader</h1>
+<h1 id="label-Sinatra%3A%3AReloader">Sinatra::Reloader<span><a href="#label-Sinatra%3A%3AReloader">&para;</a> <a href="#documentation">&uarr;</a></span></h1>

image

@randomecho

Looks like it's how rdoc is converting headings.

The test shows this:

it 'renders inline rdoc strings' do
  rdoc_app { rdoc '= Hiya' }
  assert ok?
  assert_body(/<h1[^>]*>Hiya(<span><a href=\"#label-Hiya\">&para;<\/a> <a href=\"#documentation\">&uarr;<\/a><\/span>)?<\/h1>/)
end
@zzak
Collaborator

It's because we're using RDoc, we have to update the output_decoration option.. I'll investigate.

@TrevorBramble

@zzak Found us a clue already? Do we need to reformat all of the docs for RDoc now?

@zzak
Collaborator

@TrevorBramble Sorry I haven't had time to investigate our use case, but if you check rdoc/rdoc#199 we've implemented an option to ignore this output in headings

@zzak zzak self-assigned this
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Something went wrong with that request. Please try again.