Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Documentation bug rendering markdown, starting with Lint/Debugger #10038

Closed
danbernier opened this issue Aug 24, 2021 · 2 comments
Closed

Documentation bug rendering markdown, starting with Lint/Debugger #10038

danbernier opened this issue Aug 24, 2021 · 2 comments

Comments

@danbernier
Copy link
Contributor

The HTML docs after Lint/Debugger are rendering strangely. The code samples whose lines start with # bad or # good are turning into h1.sect0 tags, and rendering as links in the right-nav.


Expected behavior

The examples from Lint/Debugger should appear as examples, not as section headers. The right-nav shouldn't be full of text links that are supposed to be code comments in the examples, like "good," and "bad (ok during development)".

Actual behavior

The code examples appear as linked section headers.

image

image

image

It continues down, beyond the code comments from the Lint/Debugger source, which makes me think it's some kind of markdown rendering mode that gets flipped, and eventually flipped back by a farther-down cop's comments.

image

Steps to reproduce the problem

Look at the first linked heading under the Lint/Debugger docs, titled bad (ok during development).

RuboCop version

This affects version 1.10, based on looking at the URLs.

@dvandersluis
Copy link
Member

dvandersluis commented Aug 24, 2021

This was fixed in #9522 (you can see it working if you look at the 1.11+ docs)

@danbernier
Copy link
Contributor Author

danbernier commented Aug 24, 2021 via email

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants