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

Views generic #18

Open
wants to merge 8 commits into
base: master
Choose a base branch
from
Open

Views generic #18

wants to merge 8 commits into from

Conversation

dotpointer
Copy link
Contributor

Adding and updating information, most notably a view behavior reference list for all behaviors I found used in the views. This is in response to the 'Document view behaviors' todo note.

@dotpointer dotpointer requested review from nomego, JockeCK and Wurper March 16, 2018 14:39
Copy link
Contributor

@JockeCK JockeCK left a comment

Choose a reason for hiding this comment

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

Wow, we have a lot of helper functions. Great work listing them all. Looks good.

Copy link
Contributor

@Wurper Wurper left a comment

Choose a reason for hiding this comment

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

Good stuff.

Copy link
Contributor

@nomego nomego left a comment

Choose a reason for hiding this comment

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

This is way too verbose and this kind of "disconnected" documentation for methods will never be updated.

Link to the generated docs for each behavior instead and make sure it's updated in the annotated documentation for each file, see http://localhost:3000/polymer/cz-behaviors/index.html

@dotpointer
Copy link
Contributor Author

This is way too verbose and this kind of "disconnected" documentation for methods will never be updated. Link to the generated docs for each behavior instead and make sure it's updated in the annotated documentation for each file, see http://localhost:3000/polymer/cz-behaviors/index.html

Pull requests has been issued in cosmoz-frontend to update in file documentation:
https://github.com/Neovici/cosmoz-frontend/pull/184
https://github.com/Neovici/cosmoz-frontend/pull/186
https://github.com/Neovici/cosmoz-frontend/pull/187

Copy link
Contributor

@nomego nomego left a comment

Choose a reason for hiding this comment

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

We should still drop the list of methods from this and only maintain the links to the automatic documentation.
We can keep the behavior description though.

@dotpointer
Copy link
Contributor Author

We should still drop the list of methods from this and only maintain the links to the automatic documentation.

Yes, that was my intent to drop the lists and link directly. I have been awaiting review of the automatic documentation to see if I was on the right track, and now as one is merged then I can continue removing the lists.

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

Successfully merging this pull request may close these issues.

4 participants