Changeset 439

Show
Ignore:
Timestamp:
05/27/07 23:23:25 (2 years ago)
Author:
athomas
Message:

cly: More documentation updates.

Files:

Legend:

Unmodified
Added
Removed
Modified
Copied
Moved

  • cly/trunk/doc/developers-guide.rst

    r438 r439  
    4040This CLY grammar is equivalent to the following EBNF-style grammar:: 
    4141 
    42   ONE := 'one' (ONE_ONE | ONE_TWO) 
     42  TOP := ONE | TWO 
     43  ONE := 'one', (ONE_ONE | ONE_TWO) 
    4344  TWO := 'two' 
    4445  ONE_ONE := 'one_one' 
    …… 
    156157      hostname=Variable('Host name')( 
    157158        Action('Add host', add_host, valid=lambda context: 'ip' in context.vars), 
    158         Traversals(0)( 
    159159        ip=Node('IP address', traversals=0)( 
    160160          ip=IP('IP address', traversals=0)( 
    …… 
    171171  ) 
    172172 
     173Which corresponds to something like this command syntax:: 
     174 
     175  add <hostname> ip <ip> [ip <ip> [ip <ip> ...]] [comment <comment>] 
     176 
    173177.. _API documentation: http://swapoff.org/cly/docs 

  • cly/trunk/doc/tutorial.rst

    r438 r439  
    159159Variables can have extra intelligence built into them to customise their 
    160160behaviour. To make life a bit easier for the end developer a selection of 
    161 variables are available in ``cly.variables``. This includes a ``File`` class 
    162 which we will use to provide file completion. 
     161variables are available in ``cly.builder``. This includes a ``File`` class 
     162which we will use to provide file completion: 
    163163 
    164164.. code-block:: python