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

doc: Add padding: 0 to pre > code #9535

Closed
wants to merge 1 commit into from
Closed

doc: Add padding: 0 to pre > code #9535

wants to merge 1 commit into from

Conversation

hiendv
Copy link

@hiendv hiendv commented Nov 10, 2016

Checklist
  • documentation is changed or added
  • commit message follows commit guidelines
Affected core subsystem(s)

doc

Description of change

peek 2016-11-10 10-46

@nodejs-github-bot nodejs-github-bot added the doc Issues and PRs related to the documentations. label Nov 10, 2016
@hiendv hiendv changed the title Add padding: 0; to pre > code doc: Add padding: 0 to pre > code Nov 10, 2016
@Trott
Copy link
Member

Trott commented Nov 10, 2016

LGTM if the @nodjes/Website folks (uh...there are 89 of them, so you know, not all of them, but at least a few) don't see a problem. I think there might be a competing fix for this already submitted, though. Anyone?

@Trott
Copy link
Member

Trott commented Nov 10, 2016

@nodejs/website

@danbev
Copy link
Contributor

danbev commented Nov 10, 2016

Thanks for doing this! We also have this PR open for this issue. I don't mind which PR gets merged just that we fix this :)

@hiendv
Copy link
Author

hiendv commented Nov 10, 2016

@Trott @danbev Sorry, I couldn't find #9482 before. Should I close mine?

@silverwind
Copy link
Contributor

Yeah, I'll close this in favor of #9482 which was first. I'm sorry and hope you find other areas to contribute.

@silverwind silverwind closed this Nov 10, 2016
@hiendv
Copy link
Author

hiendv commented Nov 10, 2016

I see. Thank you, @silverwind. I was hoping mine will be merged since the previous PR is incomplete.

@silverwind
Copy link
Contributor

silverwind commented Nov 10, 2016

I don't consider this change as the ideal solution as the <code> wrapping is unnecessary and ideally those block should just be <pre> only, with <code> being reserved for inline code blocks. That's why I requested a TODO comment.

If you like to take a look, the tool that generates the HTML lives here and you can run it through make doc-only.

@hiendv
Copy link
Author

hiendv commented Nov 10, 2016

@silverwind Oh, I missed your TODO here: #9482 (comment)

So, does it mean the <code> is deprecated for fenced code blocks?
If my assumption is right, should I change the doc generation tool & the style also? I would happily look at this and make a PR if possible.

@silverwind
Copy link
Contributor

silverwind commented Nov 10, 2016

I guess it's not as simple as I thought. The HTML5 spec recommends <pre><code></code></pre> for "a sample of computer code". While I don't particularily see a reason for it, I think it's best left as-is, so the solution here is likely proper.

@hiendv
Copy link
Author

hiendv commented Nov 11, 2016

@silverwind pre > code may be more semantic, I guess. Anyway, thanks for your time and patience.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
doc Issues and PRs related to the documentations.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

7 participants