Early Bird Registration for DrupalCon Portland 2024 is open! Register by 23:59 PST on 31 March 2024, to get $100 off your ticket.
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...
- The function doesn't appear on api.drush.org at all due (I believe) to an unclosed
@defgroup
comment right above it. - Its
@param
and@return
directives are incomplete and misformatted.
Patch to follow.
Comment | File | Size | Author |
---|---|---|---|
#1 | drush-drush_confirm-docs-1888508-1.patch | 783 bytes | TravisCarden |
Comments
Comment #1
TravisCarden CreditAttribution: TravisCarden commentedComment #2
TravisCarden CreditAttribution: TravisCarden commentedForgot tags.
Comment #3
greg.1.anderson CreditAttribution: greg.1.anderson commentedCommitted. Thanks.
Comment #4
TravisCarden CreditAttribution: TravisCarden commentedThis patch applies directly back on 7.x-5.x, as well.
Comment #5
greg.1.anderson CreditAttribution: greg.1.anderson commentedOkay, 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.
Comment #6
greg.1.anderson CreditAttribution: greg.1.anderson commentedPostscript - 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.
Comment #7
TravisCarden CreditAttribution: TravisCarden commentedAbsolutely, @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!