1
0
Fork 0
mirror of https://we.phorge.it/source/arcanist.git synced 2024-11-25 16:22:42 +01:00

Require defining workflows' synopses and help

Test Plan: Deleted `getCommandSynopses()` from workflow, ran `arc help`.

Reviewers: epriestley, edward

Reviewed By: epriestley

CC: aran, Korvin

Differential Revision: https://secure.phabricator.com/D3739
This commit is contained in:
vrana 2012-10-19 09:50:56 -07:00
parent ffac8d5c4c
commit 94d283a453

View file

@ -91,6 +91,20 @@ abstract class ArcanistBaseWorkflow {
*/
abstract public function getWorkflowName();
/**
* Return console formatted string with all command synopses.
*
* @return string 6-space indented list of available command synopses.
*/
abstract public function getCommandSynopses();
/**
* Return console formatted string with command help printed in `arc help`.
*
* @return string 10-space indented help to use the command.
*/
abstract public function getCommandHelp();
/* -( Conduit )------------------------------------------------------------ */
@ -470,14 +484,6 @@ abstract class ArcanistBaseWorkflow {
return $this->arcanistConfiguration;
}
public function getCommandSynopses() {
return get_class($this).": Undocumented";
}
public function getCommandHelp() {
return get_class($this).": Undocumented";
}
public function requiresWorkingCopy() {
return false;
}