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

Several error in the documentation #18

Open
dgabrielli76 opened this issue Jun 2, 2016 · 6 comments
Open

Several error in the documentation #18

dgabrielli76 opened this issue Jun 2, 2016 · 6 comments

Comments

@dgabrielli76
Copy link
Contributor

dgabrielli76 commented Jun 2, 2016

Description

There are several small errors in the documentation of this element.

Just one example:

Expected outcome

</script>

Actual outcome

&lt;/script>

I will fix this errors and I will propose a PR soon to fix this issue.

@notwaldorf
Copy link
Contributor

That &lt;/script> is needed so that the docs show up correctly in the catalog, but I guess that makes them look silly in the readme.

@garlicnation @arthurevans any ideas?

@arthurevans
Copy link

I don't think that you should need to escape that one bracket (weird that it's the second-to-last-one, too). But um ah I'm probably wrong?

@notwaldorf
Copy link
Contributor

notwaldorf commented Jun 7, 2016

That one bracket makes </script> and hydrolysis stops parsing anything after 😎

@arthurevans
Copy link

On a scale of 1 to bad that seems really bad. @garlicnation is this a known issue with hydrolysis?

@felixzapata
Copy link
Contributor

Hi @notwaldorf @arthurevans @garlicnation , in order to help, I think that the tag should be written like this '</\script>'. This change does not fix the issue but, I 've made a test using the demo of the `iron-doc-viewer' component and, if you use this syntax, the tag is parsed ok.

I think that hydrolysis should take care of this syntax, escaping the slash.

@felixzapata
Copy link
Contributor

felixzapata commented Jul 19, 2016

Hi again @notwaldorf @arthurevans @garlicnation, another idea.. after some tests over the iron-doc-viewer component, if you replace:

this.toggleAttribute('abstract', this.descriptor.abstract);

with this

this.set('descriptor.desc', this.descriptor.desc.replace(/\/\\script/gi, '/script'));
this.toggleAttribute('abstract', this.descriptor.abstract);

That is to say, an small fix to find and replace a pattern for the script and replace with the correct value.

After that, you can view the documentation with the script tag fixed:

app-localize-behavior_-_2016-07-19_18 16 45

But, really I am not sure if this is the best place to make the fix. I mean, maybe this small parse should be inside hydrolysis.

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

No branches or pull requests

4 participants