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

Separating html & js in bde elements breaks BDE-element-API-documentation #2

Closed
erne-mt opened this issue Aug 12, 2016 · 9 comments
Closed

Comments

@erne-mt
Copy link
Collaborator

erne-mt commented Aug 12, 2016

Is there any reason, why the elements are separated in (style) html and script files, although they build single particular element?

I have the problem that the documentation via iron-component-page breaks because of this reason.

@jtrs
Copy link
Member

jtrs commented Aug 12, 2016

Because a pure js file can lint with eslint. And it is more confortable for develop longer code.

@erne-mt
Copy link
Collaborator Author

erne-mt commented Aug 15, 2016

Ok, I can go with that.

But Polymer elements are conceptually designed to be a single entity both view and script (as well as some dependencies)

So what about polylint ?

@jtrs
Copy link
Member

jtrs commented Aug 15, 2016

I think, this is just a problem of locally development. The base uses already HTTP2, and therefore it is not really a problem anymore.

@erne-mt
Copy link
Collaborator Author

erne-mt commented Aug 15, 2016

@jtrs Your answer refers to the #3 pull request, doesn't it?

@jtrs
Copy link
Member

jtrs commented Aug 15, 2016

Both, its applies to this issue and to the pull request

@jtrs jtrs closed this as completed Aug 15, 2016
@mplabs
Copy link
Collaborator

mplabs commented Aug 17, 2016

The main issue was not addressed here. Not concatenating the elements into a single file breaks automatic documentation which is a major issue. I would like to see this addressed, or otherwise solved.

@mplabs mplabs reopened this Aug 17, 2016
@erne-mt
Copy link
Collaborator Author

erne-mt commented Aug 19, 2016

maybe is related to polymer-analyzer issue and another and a possible solution in this issue ( - JSDoc Magic).

@erne-mt erne-mt changed the title Reason for separating html & js in bde elements Separating html & js in bde elements breaks BDE-element-API-documentation Aug 19, 2016
@erne-mt
Copy link
Collaborator Author

erne-mt commented Aug 26, 2016

A possible solution is annotating the script files with an @importedBy ELEMENT.HTML comment.

@mplabs and @iskandar992 were working on a grunt-based solution with the use of polymer-analyzer

@erne-mt
Copy link
Collaborator Author

erne-mt commented Sep 2, 2016

Well, it is still not completely solved, but with @importedBy we have at least a start.

The issue with iron-component-page will still be open, and I hope the issue displaying the annotations of properties and methods will be somehow resolved by the Polymer team, possibly by including a newer analyzer version in iron-component-pages.

So I will close this for now and continue the documentation as far as possible, but as I am still working on this, I will keep this in mind.

@erne-mt erne-mt closed this as completed Sep 2, 2016
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants