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: word missing in output #2297

Closed
spadgos opened this issue Apr 13, 2015 · 8 comments · Fixed by #2299
Closed

Documentation: word missing in output #2297

spadgos opened this issue Apr 13, 2015 · 8 comments · Fixed by #2299
Labels
accepted There is consensus among the team that this change meets the criteria for inclusion archived due to age This issue has been archived; please open a new issue for any further discussion bug ESLint is working incorrectly documentation Relates to ESLint's documentation

Comments

@spadgos
Copy link
Contributor

spadgos commented Apr 13, 2015

On Working with rules under the context.report() heading, the source reads:

context.report(node, "`{{identifier}}` is unexpected!", { identifier: node.name });

But the output shows:

selection_006

@michaelficarra
Copy link
Member

Probably better to open this bug on https://github.com/eslint/eslint.github.io

@spadgos
Copy link
Contributor Author

spadgos commented Apr 13, 2015

Reported there, closing here.

@spadgos spadgos closed this as completed Apr 13, 2015
@nzakas nzakas reopened this Apr 13, 2015
@nzakas
Copy link
Member

nzakas commented Apr 13, 2015

@nzakas nzakas added bug ESLint is working incorrectly documentation Relates to ESLint's documentation accepted There is consensus among the team that this change meets the criteria for inclusion labels Apr 13, 2015
@michaelficarra
Copy link
Member

@nzakas But is the rendering of that markdown page as HTML managed here? Because that's where the problem is.

@nzakas
Copy link
Member

nzakas commented Apr 13, 2015

We don't render to HTML, we publish as markdown and Jekyll automatically does it. There is nothing else to change besides the markdown, which is managed here.

@michaelficarra
Copy link
Member

The linked markdown document has no errors, though. It renders fine on Github.

@nzakas
Copy link
Member

nzakas commented Apr 13, 2015

I'm not sure what you're arguing about. The file gets copied over as-is to the website. If you think there's another way to fix this issue other than editing the markdown, please share.

@michaelficarra
Copy link
Member

Why do you think the markdown needs to change? You either need to reconfigure or upgrade Jekyll, apparently. It is dropping the {{identifier}} portion of the Markdown document. None of that is handled in this repo.

Just to be absolutely clear here:

  • the markdown document in this repo is not broken
  • nothing in this repo needs to change
  • something in the eslint/eslint.github.io repo needs to change to handle markdown like this properly

edit: The Makefile.js that has tasks for publishing the website is strangely stored in this repo, so it could also be fixed there.

nzakas added a commit that referenced this issue May 8, 2015
Fix: sanitise Jekyll interpolation during site generation (fixes #2297)
@eslint-deprecated eslint-deprecated bot locked and limited conversation to collaborators Feb 7, 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 7, 2018
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
accepted There is consensus among the team that this change meets the criteria for inclusion archived due to age This issue has been archived; please open a new issue for any further discussion bug ESLint is working incorrectly documentation Relates to ESLint's documentation
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants