Skip to content
This repository has been archived by the owner on May 29, 2019. It is now read-only.

feat: Ensure docs example code is syntactically valid #2608

Closed
anishkny opened this issue May 14, 2018 · 2 comments
Closed

feat: Ensure docs example code is syntactically valid #2608

anishkny opened this issue May 14, 2018 · 2 comments

Comments

@anishkny
Copy link
Contributor

To prevent issues like #2606 (comment)

@equinusocio
Copy link

... and #2601

@ghost
Copy link

ghost commented May 24, 2018

Thanks for raising this :) To address it:

  • Reviews of docs will hopefully be more thorough now that 3.0 craziness is over ;)
  • I'm gradually moving larger samples to live StackBlitz demos like we have in the Quick Tour, which (in my experience anyway) helps with accuracy of code samples.
  • StackBlitz samples are not inline, they're stored in separate files (e.g. https://github.com/Polymer/docs/tree/master/app/3.0/samples) that get uploaded to StackBlitz when the user clicks on a sample. It's a little more work to set them up than just dropping some code inline in a document. I would probably not do a StackBlitz example for stuff that's just a 3-liner thing. So if this is a feature request for implementing linting/parsing of inline samples, I don't think we have the bandwidth to do that now.

@arthurevans or @keanulee might have a different take or more info. Tagging them in case that is true.

@ghost ghost closed this as completed Jul 24, 2018
This issue was closed.
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants