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

Docs: Fix code-blocks in spaced-comment docs #7524

Merged
merged 1 commit into from Nov 30, 2016

Conversation

mgol
Copy link
Contributor

@mgol mgol commented Nov 2, 2016

What is the purpose of this pull request? (put an "X" next to item)

[x] Documentation update
[ ] Bug fix (template)
[ ] New rule (template)
[ ] Changes an existing rule (template)
[ ] Add autofixing to a rule
[ ] Add a CLI option
[ ] Add something to the core
[ ] Other, please explain:

What changes did you make? (Give an overview)
I removed the indentation of the JSON code blocks.

Is there anything you'd like reviewers to focus on?
Double-check if this really fixes the issue. I don't know how to test it locally, I tried npm run gensite but it was running for ages.

Commit message:
The space-comment docs page had indented code blocks with the JSON type. Because
of that they weren't converted to HTML correctly, leaving json in plain text
on the page.

@jsf-clabot
Copy link

jsf-clabot commented Nov 2, 2016

CLA assistant check
All committers have signed the CLA.

@eslintbot
Copy link

LGTM

@mention-bot
Copy link

@mgol, thanks for your PR! By analyzing the history of the files in this pull request, we identified @pedrottimark, @scriptdaemon and @gyandeeps to be potential reviewers.

@mgol
Copy link
Contributor Author

mgol commented Nov 2, 2016

That's what it looks like currently:
screen shot 2016-11-02 at 15 12 13

Copy link
Member

@platinumazure platinumazure left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Taking a look at the preview of the commit on your branch, it looks like one of the bullet points also gets caught up in code markup. Can you please investigate?

@mgol
Copy link
Contributor Author

mgol commented Nov 2, 2016 via email

@mgol
Copy link
Contributor Author

mgol commented Nov 2, 2016 via email

@nzakas
Copy link
Member

nzakas commented Nov 3, 2016

I think we can just move the code blocks inline with the bullet that appears ahead of them.

@mgol
Copy link
Contributor Author

mgol commented Nov 6, 2016

@nzakas That will work, although it's not possible to specify the language that way. Do you want me to do that anyway?

@mgol mgol added the documentation Relates to ESLint's documentation label Nov 7, 2016
@not-an-aardvark not-an-aardvark added documentation Relates to ESLint's documentation and removed documentation Relates to ESLint's documentation labels Nov 7, 2016
@nzakas
Copy link
Member

nzakas commented Nov 8, 2016

@mgol I think the language can be reasonably inferred in this case :)

@vitorbal
Copy link
Member

@mgol could you try removing the language specification to check if it can be inferred? If that's the case, then I think we would be good to go here!

@nzakas
Copy link
Member

nzakas commented Nov 25, 2016

@vitorbal I meant the user can infer the language, not the template. :)

@vitorbal
Copy link
Member

vitorbal commented Nov 25, 2016 via email

@kaicataldo
Copy link
Member

@mgol Would love to land this - looks like one more small change is needed. Thanks!

The space-comment docs page had indented code blocks with the JSON type. Because
of that they weren't converted to HTML correctly, leaving `json` in plain text
on the page.
@eslintbot
Copy link

LGTM

@mgol
Copy link
Contributor Author

mgol commented Nov 30, 2016

@kaicataldo PR updated; sorry for the delay.

Copy link
Member

@kaicataldo kaicataldo left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM. Thanks for contributing!

@kaicataldo kaicataldo dismissed platinumazure’s stale review November 30, 2016 15:43

Issue has been resolved

@kaicataldo kaicataldo merged commit b30116c into eslint:master Nov 30, 2016
@mgol mgol deleted the fix-codeblocks branch November 30, 2016 15:48
@eslint-deprecated eslint-deprecated bot locked and limited conversation to collaborators Feb 6, 2018
@eslint-deprecated eslint-deprecated bot added the archived due to age This issue has been archived; please open a new issue for any further discussion label Feb 6, 2018
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
archived due to age This issue has been archived; please open a new issue for any further discussion documentation Relates to ESLint's documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

9 participants