Core should use "Implementation of hook_NAME()."
christefano - April 11, 2008 - 07:50
| Project: | Drupal |
| Version: | 7.x-dev |
| Component: | other |
| Category: | bug report |
| Priority: | normal |
| Assigned: | Unassigned |
| Status: | closed |
Description
This patch updates the "Implementation of hook_NAME()." text in the code comments found in Drupal's core modules. Thanks to Morbus and chx for Drupal Tough Love, where I've learned that no coding style violation is too small to go unnoticed.
For the most part all I did here was add a period to end the line. "Implementation of hook_theme()" was the most common string missing a period.
Why do user.module and node.module sometimes include "Implementation of a Drupal action" in the code comments and not include the function name?
| Attachment | Size | Status | Test result | Operations |
|---|---|---|---|---|
| core_code_comment_periods.patch | 5.95 KB | Ignored | None | None |
#1
I'd like to point out that most of these errors are the direct result of new hooks inside Drupal 6. It's just something that wasn't caught before, but it does indicate that core has been pretty careful about following the suggested guideline of a period at the end.
#2
No longer applies.
#3
Re-rolled
#4
Looks like that takes care of all of them.
#5
Committed to CVS HEAD. Yay.
#6
Automatically closed -- issue fixed for two weeks with no activity.