PolymerElements / iron-component-page

A reusable landing page for elements
36 stars 32 forks source link

Request: Generate event description automatically for properties with notify: true #87

Closed Saulis closed 8 years ago

Saulis commented 8 years ago

Especially for users unfamiliar or new to Polymer, it's not usually clear that the small notifies notation on the property actually means firing a *-changed event.

Generating event descriptions in the Events section automatically for these events would drastically improve the readability of the API for users.

justinfagnani commented 8 years ago

@garlicnation is this something we want down in Hydrolysis?

garlicnation commented 8 years ago

Yeah! We should add these events in the final annotation pass, before mixing in properties/events from behaviors.

justinfagnani commented 8 years ago

Closing in favor of https://github.com/PolymerElements/iron-doc-viewer/issues/67