I think the title says it all.

Currently it is like this:

/**
 * Page callback: Generates a derivative, given a style and image path.
 *
 * After generating an image, transfer it to the requesting agent.                                                                                                                                                      
 *
 * @param $style
 *   The image style
 */
function image_style_deliver($style, $scheme) {

This does not explain what $scheme should be.

Patch coming up.

CommentFileSizeAuthor
#5 interdiff_2480805_1-5.txt519 bytesJacobSanford
#5 add_missing_docblock_param-2480805-5.patch470 bytesJacobSanford
#1 2480805-1.patch462 byteseiriksm
Support from Acquia helps fund testing for Drupal Acquia logo

Comments

eiriksm’s picture

eiriksm
he/him
Primary language Norwegian Bokmål
Location Norway
CreditAttribution: eiriksm at Ny Media AS commented
FileSize
2480805-1.patch462 bytes
eiriksm’s picture

eiriksm
he/him
Primary language Norwegian Bokmål
Location Norway
CreditAttribution: eiriksm at Ny Media AS commented
Status: Active » Needs review

Forgot to mark as "needs review".

eiriksm’s picture

eiriksm
he/him
Primary language Norwegian Bokmål
Location Norway
CreditAttribution: eiriksm at Ny Media AS commented
Issue summary: View changes
jhodgdon’s picture

jhodgdon
she/her
Primary language English
CreditAttribution: jhodgdon as a volunteer commented
Status: Needs review » Needs work
Issue tags: +Novice

Good catch, and thanks for the patch! However, "i.e." means "that is", when what you really meant was "for example". Please write out "for example" instead of changing this to "e.g.", because there are a lot of other people out there who also don't know the difference between i.e. and e.g. and might get confused by this (better to just use English), and turn it all into one sentence.

JacobSanford’s picture

JacobSanford
Primary language English
Location Fredericton 🇨🇦
CreditAttribution: JacobSanford commented
Status: Needs work » Needs review
FileSize
add_missing_docblock_param-2480805-5.patch470 bytes
interdiff_2480805_1-5.txt519 bytes

Update as requested in #4 with interdiff.

mark.labrecque’s picture

mark.labrecque
he/him
Primary language English
Location Vancouver
CreditAttribution: mark.labrecque at ImageX commented

While we are working on this, would it be worth stating what variable type (ie string, array, etc) is expected by each parameter? It may not be a strict requirement, but I feel that maybe it should be. Any thoughts on this?

jhodgdon’s picture

jhodgdon
she/her
Primary language English
CreditAttribution: jhodgdon as a volunteer commented
Status: Needs review » Reviewed & tested by the community

The patch is fine. It would be fine to also add types to the @param lines. If you'd like to do that, upload a new patch and set back to Needs Review.

David_Rothstein’s picture

David_Rothstein CreditAttribution: David_Rothstein as a volunteer commented
Status: Reviewed & tested by the community » Fixed

Committed to 7.x - thanks!

  • David_Rothstein committed e835365 on 7.x 
    Issue #2480805 by JacobSanford, eiriksm, jhodgdon: The function doc...

Status: Fixed » Closed (fixed)

Automatically closed - issue fixed for 2 weeks with no activity.