Ignore:
Timestamp:
Aug 24, 2012 6:30:30 PM (10 years ago)
Author:
cschlep
Message:

clenup in the style guide

File:
1 edited

Legend:

Unmodified
Added
Removed
  • specdomain/trunk/src/specdomain/doc/style_guide.rst

    r1088 r1090  
    417417  definition list which is processed by sphinx to include more information,
    418418  for example, the type of an argument. Other projects, however, actively
    419   discourage its use. The syntax is as follows::
     419  discourage its use or prefer the above style for simplicity.
     420  The syntax is as follows::
    420421 
    421422    :param str motor_name: name of motor to use.
     
    428429EXAMPLE:
    429430  A short example, illustrating the usage of the macro. As in the case of the
    430   USAGE section, the syntax should appear as preformatted text, and each input
     431  USAGE section, the syntax should appear as pre-formatted text, and each input
    431432  line should start with the ``>``-symbol to represent the SPEC command line
    432433  prompt. Short explanation lines can be inserted as indented comment lines::
     
    458459
    459460  """
    460   Summary line
     461  Concise summary line.
    461462 
    462463  USAGE::
    463464   
    464     > my_move <motor> <position>
     465    > my_move <motor> <position> [<sleep_time>]
    465466   
    466467  ARGUMENTS:
    467     :motor:    The motor to be moved.
    468     :position: The position to move the motor to.
     468   
     469    Required arguments:
     470      :motor:    The motor to be moved [str].
     471      :position: The position to move the motor to [float].
     472   
     473    Optional arguments:
     474      :sleep_time: Settling time after the move has finished [float].
    469475   
    470476  EXAMPLE::
    471477 
    472     > my_move del 23.2346
    473    
     478    > my_move del 23.2346 0.3
     479        # move del to 23.2346 and wait for 0.3 seconds after move finishes.
    474480  NOTE:
    475     Indicate any side effects, restrictions or other usage notes here
     481    Indicate any side effects, restrictions or other usage notes here.
    476482   
    477483  SEE ALSO:
     
    481487  """
    482488
    483    
    484  
    485 
    486 
    487 
    488 
    489 
    490 
    491 
    492 
    493 
     489This results in the following:
     490
     491        Concise summary line.
     492               
     493        USAGE::
     494               
     495                > my_move <motor> <position> [<sleep_time>]
     496               
     497        ARGUMENTS:
     498               
     499                Required arguments:
     500                  :motor:    The motor to be moved [str].
     501                  :position: The position to move the motor to [float].
     502               
     503                Optional arguments:
     504                  :sleep_time: Settling time after the move has finished [float].
     505               
     506        EXAMPLE::
     507       
     508                > my_move del 23.2346 0.3
     509                                # move del to 23.2346 and wait for 0.3 seconds after move finishes.
     510        NOTE:
     511                Indicate any side effects, restrictions or other usage notes here.
     512               
     513        SEE ALSO:
     514                * :spec:def:`my_move2`
     515                * :spec:global:`MOVE_FLAG`
     516   
     517 
     518
     519
     520
     521
     522
     523
     524
     525
     526
Note: See TracChangeset for help on using the changeset viewer.