Download & Extend

Improve code docs for drush_invoke()

Project:Drush
Version:7.x-5.x-dev
Component:Documentation
Category:task
Priority:normal
Assigned:Unassigned
Status:closed (fixed)
Issue tags:documentation, Novice

Issue Summary

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

  1. It's missing @param and @return directives.
  2. The @see directive is malformed.
  3. Function references are missing parentheses and so don't get hyperlinked on the API site.
  4. Comments don't always wrap at 80 characters.
  5. Inline comments don't always terminate with punctuation.
  6. There are a few small typos.

Patch to follow.

Comments

#1

Assigned to:TravisCarden» Anonymous
Status:active» needs review
AttachmentSize
drush-drush_invoke-docs-1885572-1.patch 2.6 KB

#2

Status:needs review» fixed

Fixed; thanks.

#3

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

Thank you! Shall we backport it?

#4

Status:reviewed & tested by the community» fixed

Cherry-picked 461dc47a on the 7.x-5.x branch.

#5

Status:fixed» closed (fixed)

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