DraggableListBuilder needs to document its expectations

isa.bel → made their first commit to this issue’s fork.

Documentation added, moving to Needs Review status

Pipeline appears to have issue.

For good practice issue summary should be filled in also, if sections don't apply can leave blank or add NA.

If you are another contributor eager to jump in, please allow the previous poster(s) at least 48 hours to respond to feedback first, so they have the opportunity to finish what they started!

Hi,
I've rebased the branch onto the latest 11.x and fixed the coding standard issues.

All tests are now passing.

Please review when you have a moment, and feel free to let me know if anything else need.

Thank you!

As a novice task would be good practice to update issue summary.

Hi @smustgrave,

I've updated the issue summary to reflect the purpose and outcome of this task, including steps to reproduce the issue from a documentation perspective, and clarifying that this was a documentation-only change.

Please let me know if any further adjustments are needed.

Thanks!

- We only need class-level docblock
- getWeight() and setWeight() are not needed. The list builder uses the get() and set() method which all config entities have.

Hi @joachim,

I've removed MR !11745 the method-level docblocks for getWeight() and setWeight() as suggested. The class-level and constructor documentation were kept to clarify usage requirements. Let me know if anything else should be adjusted.

Thank you!

The IS needs updating too.

We really don't need docs on __construct -- they will just duplicate the class docs.

This constructor sets up the form builder for compatibility, disables
   *   pagination (to allow full drag-and-drop), and stores the weight key
   *   if it is defined in the entity type.

This is useful, but put it as an inline comment at the top of the method code.

The docs in this MR all seem very verbose -- it's not AI generated is it?

Hi @joachim,

I’ve made the changes you suggested, removed the docblock from __construct() and added the inline comment at the top of the method.

About the wording: I’m not sure if any of it was AI-generated, as the work had already been started by someone else. I just continued from what was already there.

Let me know if anything else needs changing.

Left some comments.

Issue summary update.

Hi guys,

i agree with @joachim that a lot of new comments seems redundant.
So, i made some changes which i think has enough to inform what and how we can enable the draggable list feature.

So, assuming you follow the steps-to-reproduce, the drush generator create my test entity type just like:

 *   entity_keys = {
 *     "id" = "id",
 *     "label" = "label",
 *     "uuid" = "uuid"
 *   }

so, simply adding the "weight" = "weight" into that, the draggable will works (as screenshot below)

then i thought add this simple code example at class docblock could be useful aswell.

i also removed the new "inline comment" from the construct, as the whole information at those lines already being explained at the method.

That seems like overkill to me. It's also less clear than saying in words what is needed.
Developers using this class will be creating custom entity types, so they should know what an entity keys property is.

Fair enough.

code example removed.