[UX] Add description to attributes and their parameters
There is an ongoing work started by @GromNaN to add documentation on attribute classes + parameters across Symfony codebase.
Here's what it would like in symfony/ux
- [ ]
Symfony\UX\Autocomplete\Form\AsEntityAutocompleteField - [x]
Symfony\UX\LiveComponent\Attribute\AsLiveComponent- https://github.com/symfony/ux/pull/1378 - [x]
Symfony\UX\LiveComponent\Attribute\LiveAction- https://github.com/symfony/ux/pull/1378 - [x]
Symfony\UX\LiveComponent\Attribute\LiveArg- https://github.com/symfony/ux/pull/1378 - [x]
Symfony\UX\LiveComponent\Attribute\LiveListener- https://github.com/symfony/ux/pull/1378 - [x]
Symfony\UX\LiveComponent\Attribute\LiveProp- https://github.com/symfony/ux/pull/1378 - [x]
Symfony\UX\LiveComponent\Attribute\PostHydrate- https://github.com/symfony/ux/pull/1378 - [x]
Symfony\UX\LiveComponent\Attribute\PreDehydrate- https://github.com/symfony/ux/pull/1378 - [x]
Symfony\UX\LiveComponent\Attribute\PreReRender- https://github.com/symfony/ux/pull/1378 - [ ]
Symfony\UX\Turbo\Attribute\Broadcast - [x]
Symfony\UX\TwigComponent\Attribute\AsTwigComponent- https://github.com/symfony/ux/pull/1229 - [x]
Symfony\UX\TwigComponent\Attribute\ExposeInTemplate - [x]
Symfony\UX\TwigComponent\Attribute\PostMount- https://github.com/symfony/ux/pull/1229 - [x]
Symfony\UX\TwigComponent\Attribute\PreMount- https://github.com/symfony/ux/pull/1229
(some are already well documented)
Meta-issue: https://github.com/symfony/symfony/issues/51920
Great idea! If you're reading this, please feel free to grab an attribute, describe it a bit, and open a PR. We can help during review with any phrasing - so it doesn't need to be perfect.
I started one (https://github.com/symfony/ux/pull/1229), please tell me if that's going in the good direction (style, content..) and i'll continue :)
Thank you for this issue. There has not been a lot of activity here for a while. Has this been resolved?