API page: http://api.drupal.org/api/drupal/includes--install.inc/class/DatabaseTas...

Describe the problem you have found:
Superfluous "@class" declaration

Comments

jhodgdon’s picture

Title: Documentation problem with DatabaseTaskException » DatabaseTaskException has @class near top and shouldn't
Issue tags: +Novice, +Needs backport to D7

Good catch, good project for a novice doc contributor, and needs backport to d7

barbi’s picture

Assigned: Unassigned » barbi
Status: Active » Needs review
StatusFileSize
new410 bytes
mr.baileys’s picture

Status: Needs review » Reviewed & tested by the community

Thanks barbi!

jhodgdon’s picture

Status: Reviewed & tested by the community » Needs work

Could we perhaps clean up that sentence?

/**
- * @class Exception class used to throw error if the DatabaseInstaller fails.
+ * Exception class used to throw error if the DatabaseInstaller fails.
  */
 class DatabaseTaskException extends Exception {

It should start with a verb and it needs an "an" in there. Probably should be something like... hmmm. not sure. What verb do we use for other exceptions?

barbi’s picture

Based on the other examples found, how about
"Exception thrown if the DatabaseInstaller fails."

jhodgdon’s picture

Agreed, that is in line with most of the other exceptions we have. Except: what is a DatabaseInstaller? We don't have a class by that name as far as I can tell. Probably that should just be "database installer"?

barbi’s picture

Status: Needs work » Needs review
StatusFileSize
new392 bytes

"database installer" is the terminology used to refer to DatabaseTasks. Using the same in this patch.

jhodgdon’s picture

Status: Needs review » Reviewed & tested by the community

Thanks, looks good to me! Please commit to 7.x/8.x.

webchick’s picture

Status: Reviewed & tested by the community » Fixed

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

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