Early Bird Registration for DrupalCon Portland 2024 is open! Register by 23:59 PST on 31 March 2024, to get $100 off your ticket.
Problem/Motivation
\Drupal\serialization\Normalizer\FieldableEntityNormalizerTrait::extractBundleData() has the following docblock:
* @return string
* The valid bundle name.
However, the return value is an array:
return [$bundle_key => $bundle_value];
Steps to reproduce
Proposed resolution
Fix the docblock to match the code.
Remaining tasks
User interface changes
API changes
Data model changes
Release notes snippet
Comment | File | Size | Author |
---|---|---|---|
#16 | 3174108-16.patch | 1.23 KB | NivethaSubramaniyan |
| |||
#14 | interdiff_11-14.txt | 801 bytes | asad_ahmed |
#14 | 3174108-14.patch | 1.23 KB | asad_ahmed |
#11 | interdiff_3174108_7-10.txt | 736 bytes | _pratik_ |
#11 | 3174108-11.patch | 1.31 KB | _pratik_ |
|
Comments
Comment #7
rivimeySuggested by https://lendude.gitlab.io/bug-smash-initiative/
Issue is correct, docs return type is incorrect. Patch fixes that and improves some other aspects of that function docblock.
Comment #8
nod_Comment #9
longwaveCSpell caught a spelling error:
ineligable -> ineligible
Otherwise this looks good to me.
Comment #10
_pratik_ CreditAttribution: _pratik_ as a volunteer and at Specbee for Drupal India Association commentedComment #11
_pratik_ CreditAttribution: _pratik_ as a volunteer and at Specbee for Drupal India Association commentedAttache updated patch with inter diff
Thanks
Comment #12
rivimeyDo it!
Comment #13
alexpottThis documentation is confusing. It took me a while to get why this was here. At first I was wondering why we are documenting return things in @param. But I see, this is passed in by reference. For me the current comment is a bit to like implementation. I think this will be clearer and easier to think about if it was more similar to the comment where this method is called:
So something like:
Comment #14
asad_ahmed CreditAttribution: asad_ahmed at OpenSense Labs commentedMade changes as per #13. Please review. Thanks
Comment #15
alexpottThe indentation of the new text is not correct here.
Comment #16
NivethaSubramaniyan CreditAttribution: NivethaSubramaniyan as a volunteer and at Srijan | A Material+ Company for Drupal India Association commentedFixing CCF in #14
Comment #17
nod_Comment #18
alexpottCommitted and pushed 7ad6ad979a to 10.1.x and a4fc325d58 to 10.0.x and 0114e01cba to 9.5.x and 7af567b658 to 9.4.x. Thanks!