Add note on .sync camelCasing in documentation

[robertjk]

What problem does this feature solve?

The problem is that the documentation on Custom Events: Event Names states:

we recommend you always use kebab-case for event names.

With .sync modifier you must emit event update:propertyName with propertyName camelCased. With kebab-case it doesn't work at all. So in the quoted text it's not always: more like always unless you emit event for .sync.

What does the proposed API look like?

You should add a note about that in Custom Events: Event Names.

Also in the documentation Custom Events: .sync modifier I would change the example to use a property with multiple word name (now it's a single word title, which doesn't help with this problem) and/or add a note about this event name incosistency with previous recommendation on the same page ("always use kebab case").

[chrisvfritz]

Thanks for bringing this up. 🙂 I think I have a compromise change would allow $emit('update:property-name') to work without any breaking changes. We're discussing it now internally, but I'll add a note if it ends up not being possible.

[robertjk]

Alright :).

[NataliaTepluhina]

Closing as related PR was merged