- Issue created by @joachim
- 🇬🇧United Kingdom joachim
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!
- First commit to issue fork.
- 🇮🇳India govind_giri_goswami
govind_giri_goswami → changed the visibility of the branch 3411186- to hidden.
- 🇮🇳India govind_giri_goswami
govind_giri_goswami → changed the visibility of the branch 3411185- to hidden.
- 🇮🇳India govind_giri_goswami
govind_giri_goswami → changed the visibility of the branch 3411185-docs-for-return to hidden.
- Merge request !6469Issue #3411185: docs for return values from various EntityDisplayRepositoryInterface() are unclear → (Open) created by govind_giri_goswami
- Status changed to Needs review
5 months ago 8:14am 6 February 2024 - 🇮🇳India govind_giri_goswami
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.
- 🇧🇪Belgium borisson_ Mechelen, 🇧🇪
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 - Status changed to Needs work
4 months ago 12:37pm 12 February 2024 - 🇬🇧United Kingdom joachim
> 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.
- Assigned to akshaydalvi212
- Issue was unassigned.