Documentation!

[rwjblue]

• API docs
  • did-insert
  • did-update
  • will-destroy
• General usage guides
  • Copy usage examples from Render Element Modifiers rfcs#415 (Begin fleshing out README with info from emberjs/rfcs#415. #3)
  • Identify common example scenarios, document how to handle them...

[knownasilya]

Worth adding e-c-addon-docs?

[rwjblue]

@knownasilya - I haven't dug into it much yet, but yeah that sounds like it might make the whole process a bit nicer.

[locks]

@emberjs/learning-team-managers

[GavinJoyce]

✋ I'll take on writing the API docs

[GavinJoyce]

@rwjblue do the API checkboxes above refer to creating docs in the modifier source files or somewhere else?

[rwjblue]

@GavinJoyce - Ya, I was thinking that inline docs (plus something like documentation package to generate an API.md) would work well.

[GavinJoyce]

👍 thanks

[tomdale]

@GavinJoyce Where are we at on this?

[GavinJoyce]

@tomdale Here's a PR which adds some API docs for {{did-insert}}, {{did-update}} and {{will-destroy}}

[lupestro]

And the docs should mention the thing I stumbled over recently - when you use FastBoot, you will get calls to the actions of {{did-insert}} and {{will-destroy}} with element === null. Since I'm usually adding focus listeners to focusable elements within a contextual block or some such thing, in my code, I was able to just if around all that safely - it won't matter in the fastboot snapshot - but it helps to anticipate it.

[rwjblue]

@lupestro - This is a bug, and should be fixed in Ember (and the polyfill). Likely the same as emberjs/ember.js#17949.