patch attached.

Files: 
CommentFileSizeAuthor
#5 function-header-coding-standards-1485966-5.patch476 bytesvegantriathlete
PASSED: [[SimpleTest]]: [MySQL] 35,650 pass(es).
[ View ]
#2 function-header-coding-standards-1485966-2.patch451 bytesvegantriathlete
PASSED: [[SimpleTest]]: [MySQL] 37,724 pass(es).
[ View ]
#1 function-header-coding-standars-1485966-1].patch451 bytesvegantriathlete
PASSED: [[SimpleTest]]: [MySQL] 37,730 pass(es).
[ View ]

Comments

vegantriathlete’s picture

StatusFileSize
new451 bytes
PASSED: [[SimpleTest]]: [MySQL] 37,730 pass(es).
[ View ]

And here it is!

vegantriathlete’s picture

StatusFileSize
new451 bytes
PASSED: [[SimpleTest]]: [MySQL] 37,724 pass(es).
[ View ]

Let's try that again with the patch named without typos.

vegantriathlete’s picture

Status:Active» Needs review

And how about remembering to set the status?

vegantriathlete’s picture

I've got the patch rolled for 8.x as well, but I know NOT to include it yet or I will hose things.

vegantriathlete’s picture

Version:7.12» 8.x-dev
StatusFileSize
new476 bytes
PASSED: [[SimpleTest]]: [MySQL] 35,650 pass(es).
[ View ]

#2 is for D7. Attached patch is for D8.

rafamd’s picture

Component:image system» documentation
rafamd’s picture

Component:documentation» image system

ooops .. restoring component

kid_icarus’s picture

Status:Needs review» Needs work

#5 applies cleanly at 89f2654

+++ b/core/modules/image/image.module
@@ -34,7 +34,7 @@ define('IMAGE_STORAGE_MODULE', IMAGE_STORAGE_OVERRIDE | IMAGE_STORAGE_DEFAULT);
/**
- * Implement of hook_help().
+ * Implements hook_help().
  */

This looks good!

However, can you please include parameter comments for $path and $arg, as well as the return comment?

Please reference http://drupal.org/node/1354/#functions under Parameters and also Return Value

rafamd’s picture

Component:image system» documentation
Status:Needs work» Reviewed & tested by the community

Well, this kind of functions (hooks) have a slightly different documentation standard (found on a different section of the same page you linked), see: http://drupal.org/node/1354/#hookimpl

To cite the first pragraph: "If the implementation of a hook is rather standard and does not require more explanation than the hook reference provides, a shorthand documentation form may be used in place of the full function documentation block described above:"

Given that this seems to be a standard implementation of the hook and that the patch applies cleanly, RTBC, IMHO (revert if you disagree).

vegantriathlete’s picture

Component:documentation» image.module

This is a change to image.module not documentation.

kid_icarus’s picture

@rafamd You are correct. I stand corrected: no @param or @return for a hook implementation. :) Thanks @vegantriathlete!

Second on the rtbc, unless there is a pending larger documentation patch dealing with the entire image module.

Which there is :-( #1326608: Clean up API docs for image module

Thoughts?

rafamd’s picture

ouch! :)

I'd say close this issue and enhance that other one (will facilitate commiter's job).

checked and this change isn't included in the proposed patch.

vegantriathlete’s picture

Don't forget that I also included a patch for D7. How about getting RTBC for the D7 patch so that can be rolled before the backport to D7 for the above issue?

rafamd’s picture

This is only my opinion and is that joint efforts are good, making everyones life easier. Just imagine if we had one issue with 15 comments for every little change in that other issue (strange example to make my point). Of course everyone's work on little issues like this one is *very* valuable, but if there's a bigger issue that involves this one, the effort will be more efficient there. Just my 2 cents.

Now, this issue is already RTBC, so .. it might be commited if left untouched. Again, for reference, this change wasn't included in the other issue's patch.

webchick’s picture

Component:image.module» documentation
Status:Reviewed & tested by the community» Fixed

I'm ok with committing this little fix by itself, but yeah in general let's do these types of clean-ups in bigger chunks so the needs review/needs work/needs review/needs work/needs review/rtbc can happen fewer times.

Committed and pushed to 8.x and 7.x. Thanks!

Status:Fixed» Closed (fixed)

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

Anonymous’s picture

Issue summary:View changes

patch has passed testing