docs for return values from various EntityDisplayRepositoryInterface() are unclear

This should also say that the 'default' view mode is not returned -- using the return of one of these to iterate through getViewDisplay() for all modes will omit it!

govind_giri_goswami → changed the visibility of the branch 3411186- to hidden.

govind_giri_goswami → changed the visibility of the branch 3411185- to hidden.

govind_giri_goswami → changed the visibility of the branch 3411185-docs-for-return to hidden.

Each method (e.g., getAllViewModes(), getViewModes(), getAllFormModes(), getFormModes()) is now individually documented. Previously, their return documentation simply stated @return array, lacking clarity on the array's structure. The updated documentation provides additional details for clarity, enhancing developers' understanding.

I think this is mostly better than what we had in the original docblocks, but the wording here is not something we typically use in Core. I think we should only include the ones we know for sure that exist.

Can we find documentation that is similar and copy the style?
Not sure what @joachim thinks about this

> I think we should only include the ones we know for sure that exist.

Agreed.

If other keys might exist, we can say that, for instance (totally making this up) 'Further properties may be added by modules that implement hook_foo_alter()'.

If the return of all of these has the same format, I think it's ok to use a @see getAllViewModes() and only have the docs in one place.

Also see #2.

Will provide some docs for the returns values.

By looking at the failed tests I think there is typo "Initail"

I am working on this issue

I have updated the spellcheck and the pipeline is failing in different functional tests related to the Umami and that doesn't suits for this document return type issue.

Did a rebase and the pipeline is green again

I have reviewed the fix, the pipeline is green and spell mistake has been corrected.

Thank you @sadamafridi and @rodrigoaguilera for reviewing the issue and updating the comments

Thanks for working on this!

The issue summary and title state this is for EntityDisplayRepositoryInterface() and yet there are changes to several files in the composer directory. Those are out of scope and should be moved to their own issue.

Thanks

I should have added that we do have guidelines for scoping of an issue, Issue scope guidelines for Drupal core issues → . They explain why we limit the scope of an issue.