function topic_drush_command

8.0.x topic.drush.inc topic_drush_command()
6.x topic.drush.inc topic_drush_command()
7.x topic.drush.inc topic_drush_command()
4.x topic.drush.inc topic_drush_command()
5.x topic.drush.inc topic_drush_command()
master topic.drush.inc topic_drush_command()

Implementation of hook_drush_command().

Return value

An associative array describing your command(s).

File

commands/core/topic.drush.inc, line 14
Topic command and associated hooks.

Code

function topic_drush_command() {
  $items['core-topic'] = array(
    'description' => 'Read detailed documentation on a given topic.',
    'arguments' => array(
      'topic name' => 'The name of the topic you wish to view. If omitted, list all topic descriptions (and names in parenthesis).',
    ),
    'examples' => array(
      'drush topic' => 'Show all available topics.',
      'drush topic docs-context' => 'Show documentation for the drush context API',
      'drush docs-context' => 'Show documentation for the drush context API',
    ),
    'bootstrap' => DRUSH_BOOTSTRAP_DRUSH,
    'aliases' => array('topic'),
    'topics' => array('docs-readme'),
  );

  return $items;
}