Changeset 1124

Timestamp:

Oct 1, 2012 1:08:46 PM (10 years ago)

Author:

jemian

Message:

fixes #35 and #36

Location:

specdomain/trunk/src/specdomain

Files:

• LICENSE (modified) (2 diffs)
• doc/style_guide.rst (modified) (6 diffs)
• sphinxcontrib/specmacrofileparser.py (modified) (5 diffs)

specdomain/trunk/src/specdomain/LICENSE

@@ -1 +1 @@
 Copyright (c) 2011-2012, UChicago Argonne, LLC
-
+Operator of Argonne National Laboratory
 All Rights Reserved
 
 specdomain
-
-BCDA, Advanced Photon Source, Argonne National Laboratory
 
 
@@ -40 +38 @@
 
 Neither the United States GOVERNMENT, nor the United States Department 
-of Energy, NOR uchicago argonne, LLC, nor any of their employees, makes 
+of Energy, NOR UChicago Argonne, LLC, nor any of their employees, makes 
 any warranty, express or implied, or assumes any legal liability or 
 responsibility for the accuracy, completeness, or usefulness of any 

specdomain/trunk/src/specdomain/doc/style_guide.rst

@@ -25 +25 @@
   throws readers out of their rhythm when they go to read it. Avoid this. 
 
-With these words in mind, this style guides documents the conventions set forth
-to use for SPEC macros at the APS.
+With these words in mind, this SPEC Documentation Style Guide documents 
+the conventions set forth to use for SPEC macros at the APS.
 
 The concept of docstrings
@@ -178 +178 @@
   It is recommended to build up this section as a definition list. The headings
   for each item are CAPITALIZED and end with a colon. The content under each of
-  these items should be indented one level. This results in a more leightweight
+  these items should be indented one level. This results in a more lightweight
   layout, and prevents cluttering the tables of content with too many
   subsections.
   
-  The following items should be included, preferrably in this order:
+  The following items should be included, preferably in this order:
   
   * AUTHOR(S):
@@ -193 +193 @@
   * KNOWN BUGS:
   
-  See the below example for more details on each of these items.
+  See the example below for more details on each of these items.
   
 
@@ -278 +278 @@
         
                 Copyright (c) 2010-|current_year|, UChicago Argonne, LLC
-        
+                Operator of Argonne National Laboratory
                 All Rights Reserved
         
                 APS SPEC macros
-        
-                APS SPEC development team,
-                X-ray Science Division and APS Engineering Support Division,
-                Argonne National Laboratory
         
         LICENSE::
@@ -321 +317 @@
         
                 Neither the United States GOVERNMENT, nor the United States Department
-                of Energy, NOR uchicago argonne, LLC, nor any of their employees, makes
+                of Energy, NOR UChicago Argonne, LLC, nor any of their employees, makes
                 any warranty, express or implied, or assumes any legal liability or
                 responsibility for the accuracy, completeness, or usefulness of any
@@ -389 +385 @@
   indicate that they should be replaced by actual values in the macro call.
   Optional arguments are additionally enclosed in square brackets (``[]``).
-  The actual USAGE syntax should appear as preformatted text, and each input
+  The actual USAGE syntax should appear as pre-formatted text, and each input
   line should start with a "``>``"-symbol to represent the SPEC command line
   prompt::

specdomain/trunk/src/specdomain/sphinxcontrib/specmacrofileparser.py

@@ -37 +37 @@
 extended_comment_marker     = r'\"{3}'
 extended_comment_match      = r'(' + extended_comment_marker + r')'
-macro_name                  = r'[a-zA-Z_][\w_]*'
+macro_name                  = r'\w+'
 macro_name_match            = r'(' + macro_name + r')'
 arglist_match               = r'(' + match_all + r')'
@@ -94 +94 @@
                         + arg_list_match                    # 3: optional arguments
                         + non_greedy_whitespace
-                        + '\''                              # start body section
+                        + r"[\\']+"                          # start body section
                         + non_greedy_filler_match           # 4: body
-                        + '\''                              # end body section
+                        + r"[\\']+"                          # end body section
                         + non_greedy_whitespace
                         + r'(#.*?)?'                        # 5: optional comment
@@ -201 +201 @@
             'local': self.handle_other,
             'rdef': self.handle_other,
+            'function rdef': self.handle_def,
         }
         process_first_list = ('descriptive comment', )
@@ -222 +223 @@
             for item in db[linenumber]:
                 if item['objtype'] not in process_first_list:
+                    if 'function rdef' == item['objtype']:
+                        pass
                     handler_method[item['objtype']](item, db)
             
@@ -423 +426 @@
                     if m is not None:
                         objtype = 'function ' + objtype
+                        if 'function rdef' == objtype:
+                            pass  # TODO: Should we do something special here?
                         args = m.group(1)
             d = {