Support for Drupal 7 is ending on 5 January 2025—it’s time to migrate to Drupal 10! Learn about the many benefits of Drupal 10 and find migration tools in our resource center.
Missing @return tag in:
- /core/modules/help/src/Plugin/Block/HelpBlock.php getActiveHelp(Request $request)
- /core/modules/hal/src/Normalizer/ContentEntityNormalizer.php denormalize($data, $class, $format = NULL, array $context = array())
- /core/modules/book/src/Tests/BookTest.php createBookNode($book_nid, $parent = NULL)
Comment | File | Size | Author |
---|---|---|---|
#29 | interdiff-2607332-26-29.txt | 583 bytes | r_sharma08 |
#29 | missing_return_tag-2607332-29.patch | 2.02 KB | r_sharma08 |
#26 | interdiff-2607332-23-26.txt | 569 bytes | r_sharma08 |
#26 | missing_return_tag-2607332-26.patch | 2.02 KB | r_sharma08 |
#23 | interdiff-2607332-20-23.txt | 557 bytes | r_sharma08 |
Comments
Comment #2
Anonymous (not verified) CreditAttribution: Anonymous at XIO commentedComment #3
jhodgdonThanks... I am not sure this is quite right though:
That doesn't seem right to me, since the $class param documentation is:
texts -> text strings
Text is not a countable noun, at least in this context, so it should not be pluralized.
Comment #4
ashhishhh CreditAttribution: ashhishhh at Valuebound commentedComment #5
snehi CreditAttribution: snehi as a volunteer and at Publicis Sapient for Publicis Sapient commentedHi @jhodgdon,
Can y0u please elaborate what to write in 3.1.
Done with 3.2
Attching patch and interdiff.
Comment #6
rakesh.gectcr@snehi,
Please try to work on the unassigned issue. There are lots of un assigned issues are available in the queue. It is assigned to some one , that means he is working on it, Please understand. You are doing this for many times. I found out in couple of issues.
Disadvantage: Somebody is assigned , they will be really following up that issues. Time is precious, should not end in wasting time of any contributors. Please do understand.
Comment #7
ashhishhh CreditAttribution: ashhishhh at Valuebound commentedHi @jhodgdon,
I corrected
@param string $class
And I included your 2nd point as well.
Please find my patch
Regards,
Ashish
Comment #8
dawehnerCan we typehint EntityInterface if we know it will be an entity?
Comment #9
ashhishhh CreditAttribution: ashhishhh at Valuebound commented@dawehner But $data is serialized form.
I don't think we can do that.
Comment #10
ashhishhh CreditAttribution: ashhishhh at Valuebound commentedComment #11
ashhishhh CreditAttribution: ashhishhh at Valuebound commentedSorry @dawehner, I understood your point bit late.
Please find new patch.
Thanks for suggestion.
Comment #12
jhodgdonThanks for the patch! Sorry for delay in review -- I've been on vacation.
I think this needs some additional work, and I don't really understand why this issue was filed about 3 random missing @return tags in 3 completely different areas of the code... but anyway:
What is a "denormalized entity object"? I honestly have no idea.
This isn't accurate. Take a look at the code -- it always returns a string.
Comment #13
r_sharma08 CreditAttribution: r_sharma08 at Publicis Sapient for Publicis Sapient commentedDue to no activity for a longer time, I am assigning this issue to myself.
Comment #14
ashhishhh CreditAttribution: ashhishhh at Valuebound commentedHi @jhodgdon,
I tried to address both point here.
Comment #15
ashhishhh CreditAttribution: ashhishhh at Valuebound commentedComment #16
jhodgdon@ashhishhh: Normally, just after someone assigns an issue to themselves, you shouldn't jump in and make a patch. The more polite thing to do is to wait a few days, and if there is still no activity, post a comment asking if they are planning to make a patch. Only then, if there is no response, then you could assign the issue to yourself and make a patch. So going forward, if an issue is assigned to someone else, please follow that procedure. Thanks!
In any case, I reviewed the interdiff in #14... Still can be improved:
OK, I at least know what this means now; no idea if it is accurate. But the grammar needs a cleanup:
unserialize => unserialized
serialize => serialized
And... So entity object implies it is not serialized. And presumably $data in the param docs (I hope?) says it is serialized data. So... Probably this whole thing needs rewording, to something like:
An entity object containing the data in $data.
This is better! But really in D8 we don't have "active menu items" any more. As you can see from the parameter, it's for the current request.
Comment #17
r_sharma08 CreditAttribution: r_sharma08 at Publicis Sapient for Publicis Sapient commentedThanks @jhodgdon.
Patch applied, kindly review it.
Comment #18
r_sharma08 CreditAttribution: r_sharma08 at Publicis Sapient for Publicis Sapient commentedComment #19
jhodgdonThanks for the new patch! I reviewed the whole patch this time, not the interdiff...
Hmmm... See comment #16, item 1. I suggested different wording, because entity objects are by definition unserialized.
The rest looks good!
Comment #20
r_sharma08 CreditAttribution: r_sharma08 at Publicis Sapient for Publicis Sapient commentedThanks jhodgdon
Patched, please review.
Comment #21
snehi CreditAttribution: snehi as a volunteer and at Publicis Sapient for Publicis Sapient commentedBlank space, Please configure your IDE for not doing this.
Comment #22
snehi CreditAttribution: snehi as a volunteer and at Publicis Sapient for Publicis Sapient commentedComment #23
r_sharma08 CreditAttribution: r_sharma08 at Publicis Sapient for Publicis Sapient commentedPatch updated, please review.
Comment #24
heykarthikwithuyou can add description for @throws.
Comment #25
jhodgdonThanks!
Note that #24 is out of scope for this issue. You can file a new issue about this if you want to.
There is still one problem with the patch though:
This needs to end in .
Comment #26
r_sharma08 CreditAttribution: r_sharma08 at Publicis Sapient for Publicis Sapient commentedcorrected and updated patch.
Comment #27
snehi CreditAttribution: snehi as a volunteer and at Publicis Sapient for Publicis Sapient commentedComment #28
snehi CreditAttribution: snehi as a volunteer and at Publicis Sapient for Publicis Sapient commentedMissing fullstop here at the end of the line.
Anyway patch is looking good now. Thanks for your contribution.
Cheers !!!
Comment #29
r_sharma08 CreditAttribution: r_sharma08 at Publicis Sapient for Publicis Sapient commentedPatch attached, please review.
Comment #32
jhodgdonOK, good! Thanks! Committed to both 8.x branches (with a small fix to indentation in EntityNormalizer).