Ignore:
Timestamp:
Oct 1, 2012 1:08:46 PM (10 years ago)
Author:
jemian
Message:

fixes #35 and #36

File:
1 edited

Legend:

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

    r1113 r1124  
    2525  throws readers out of their rhythm when they go to read it. Avoid this.
    2626
    27 With these words in mind, this style guides documents the conventions set forth
    28 to use for SPEC macros at the APS.
     27With these words in mind, this SPEC Documentation Style Guide documents
     28the conventions set forth to use for SPEC macros at the APS.
    2929
    3030The concept of docstrings
     
    178178  It is recommended to build up this section as a definition list. The headings
    179179  for each item are CAPITALIZED and end with a colon. The content under each of
    180   these items should be indented one level. This results in a more leightweight
     180  these items should be indented one level. This results in a more lightweight
    181181  layout, and prevents cluttering the tables of content with too many
    182182  subsections.
    183183 
    184   The following items should be included, preferrably in this order:
     184  The following items should be included, preferably in this order:
    185185 
    186186  * AUTHOR(S):
     
    193193  * KNOWN BUGS:
    194194 
    195   See the below example for more details on each of these items.
     195  See the example below for more details on each of these items.
    196196 
    197197
     
    278278       
    279279                Copyright (c) 2010-|current_year|, UChicago Argonne, LLC
    280        
     280                Operator of Argonne National Laboratory
    281281                All Rights Reserved
    282282       
    283283                APS SPEC macros
    284        
    285                 APS SPEC development team,
    286                 X-ray Science Division and APS Engineering Support Division,
    287                 Argonne National Laboratory
    288284       
    289285        LICENSE::
     
    321317       
    322318                Neither the United States GOVERNMENT, nor the United States Department
    323                 of Energy, NOR uchicago argonne, LLC, nor any of their employees, makes
     319                of Energy, NOR UChicago Argonne, LLC, nor any of their employees, makes
    324320                any warranty, express or implied, or assumes any legal liability or
    325321                responsibility for the accuracy, completeness, or usefulness of any
     
    389385  indicate that they should be replaced by actual values in the macro call.
    390386  Optional arguments are additionally enclosed in square brackets (``[]``).
    391   The actual USAGE syntax should appear as preformatted text, and each input
     387  The actual USAGE syntax should appear as pre-formatted text, and each input
    392388  line should start with a "``>``"-symbol to represent the SPEC command line
    393389  prompt::
Note: See TracChangeset for help on using the changeset viewer.