The drush_confirm() code comments have several issues that need fixed to make them display properly on the API site, and to conform to Drupal's Doxygen and comment formatting conventions. Most importantly...

  1. The function doesn't appear on at all due (I believe) to an unclosed @defgroup comment right above it.
  2. Its @param and @return directives are incomplete and misformatted.

Patch to follow.

Members fund testing for the Drupal project. Drupal Association Learn more


TravisCarden’s picture

Assigned: TravisCarden » Unassigned
Status: Active » Needs review
783 bytes
TravisCarden’s picture

Issue tags: +documentation, +Novice

Forgot tags.

greg.1.anderson’s picture

Status: Needs review » Fixed

Committed. Thanks.

TravisCarden’s picture

Version: 8.x-6.x-dev » 7.x-5.x-dev
Status: Fixed » Reviewed & tested by the community

This patch applies directly back on 7.x-5.x, as well.

greg.1.anderson’s picture

Status: Reviewed & tested by the community » Fixed

Okay, I cherry picked d385642dc7b on 7.x-5.x too, but in general I don't know if its worthwhile to backport small doc changes to Drush 5.

greg.1.anderson’s picture

Postscript - not to sound ungrateful; I appreciate the docs corrections. Maybe you could mention in the original patch if its applicable to both branches, so we can look at it once.

TravisCarden’s picture

Absolutely, @greg.1.anderson. If a patch is applicable to both branches I'll say so in its comment. Thanks for your candor and for enabling me to contribute!

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