X-Git-Url: https://code.grnet.gr/git/kamaki/blobdiff_plain/3ae6011276315f2785715a7b49e927ef5c419949..0ea31480bc19a613039427ea6c56348561f9d158:/docs/developers/adding-commands.rst diff --git a/docs/developers/adding-commands.rst b/docs/developers/adding-commands.rst index d9072db..68b9af1 100644 --- a/docs/developers/adding-commands.rst +++ b/docs/developers/adding-commands.rst @@ -42,9 +42,9 @@ The above example will be used throughout the present guide for clarification pu The CommandTree structure ------------------------- -CommandTree manages a command by its path. Each command is stored in multiple nodes on the tree, so that the last term is a leaf and the route from root to that leaf represents the command path. For example the commands *store upload*, *store list* and *store info* are stored together as shown bellow:: +CommandTree manages a command by its path. Each command is stored in multiple nodes on the tree, so that the last term is a leaf and the route from root to that leaf represents the command path. For example the commands *file upload*, *file list* and *file info* are stored together as shown bellow:: - - store + - file ''''''''|- info |- list |- upload @@ -125,7 +125,7 @@ The description of each command is the first line of the class commend. The foll Declare run-time argument ------------------------- -The argument mechanism allows the definition of run-time arguments. Some basic argument types are defined at the `argument module `_, but it is not uncommon to extent these classes in order to achieve specialized type checking and syntax control (e.g. at `pithos_cli module `_). +The argument mechanism allows the definition of run-time arguments. Some basic argument types are defined at the `argument module `_, but it is not uncommon to extent these classes in order to achieve specialized type checking and syntax control (e.g. at `pithos cli module `_). To declare a run-time argument on a specific command, the object class should initialize a dict called *arguments* , where Argument objects are stored. Each argument object is a possible run-time argument. Syntax checking happens at client level, while the type checking is implemented in the Argument code (thus, many different Argument types might be needed).