Source Code for Module prompt.doc_string

 1  ############################################################################### 
 2  #                                                                             # 
 3  # Copyright (C) 2005 Edward d'Auvergne                                        # 
 4  #                                                                             # 
 5  # This file is part of the program relax.                                     # 
 6  #                                                                             # 
 7  # relax is free software; you can redistribute it and/or modify               # 
 8  # it under the terms of the GNU General Public License as published by        # 
 9  # the Free Software Foundation; either version 2 of the License, or           # 
10  # (at your option) any later version.                                         # 
11  #                                                                             # 
12  # relax is distributed in the hope that it will be useful,                    # 
13  # but WITHOUT ANY WARRANTY; without even the implied warranty of              # 
14  # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the               # 
15  # GNU General Public License for more details.                                # 
16  #                                                                             # 
17  # You should have received a copy of the GNU General Public License           # 
18  # along with relax; if not, write to the Free Software                        # 
19  # Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA   # 
20  #                                                                             # 
21  ############################################################################### 
22   
23   
24 -def regexp_doc(): 
25      """Function for returning the docstring for regular expression.""" 
26   
27      doc = """ 
28   
29          Regular expression 
30          ~~~~~~~~~~~~~~~~~~ 
31   
32          The python function 'match', which uses regular expression, is used to determine which data 
33          type to set values to, therefore various data_type strings can be used to select the same 
34          data type.  Patterns used for matching for specific data types are listed below. 
35   
36          This is a short description of python regular expression, for more information see the 
37          regular expression syntax section of the Python Library Reference.  Some of the regular 
38          expression syntax used in this function is: 
39   
40              '[]':  A sequence or set of characters to match to a single character.  For example, 
41              '[Ss]2' will match both 'S2' and 's2'. 
42   
43              '^':  Match the start of the string. 
44   
45              '$':  Match the end of the string.  For example, '^[Ss]2$' will match 's2' but not 'S2f' 
46              or 's2s'. 
47   
48              '.':  Match any character. 
49   
50              'x*':  Match the character 'x' any number of times, for example 'x' will match, as will 
51              'xxxxx' 
52   
53              '.*':  Match any sequence of characters of any length. 
54   
55          Importantly, do not supply a string for the data type containing regular expression.  The 
56          regular expression is implemented so that various strings can be supplied which all match 
57          the same data type. 
58      """ 
59   
60      return doc 
61