]> git.madduck.net Git - etc/vim.git/blob - tests/data/docstring.py

madduck's git repository

Every one of the projects in this repository is available at the canonical URL git://git.madduck.net/madduck/pub/<projectpath> — see each project's metadata for the exact URL.

All patches and comments are welcome. Please squash your changes to logical commits before using git-format-patch and git-send-email to patches@git.madduck.net. If you'd read over the Git project's submission guidelines and adhered to them, I'd be especially grateful.

SSH access, as well as push access can be individually arranged.

If you use my repositories frequently, consider adding the following snippet to ~/.gitconfig and using the third clone URL listed for each project:

[url "git://git.madduck.net/madduck/"]
  insteadOf = madduck:

ee6d0c051d700bff8953ea5b1402a31896950450
[etc/vim.git] / tests / data / docstring.py
1 class MyClass:
2   """ Multiline
3   class docstring
4   """
5
6   def method(self):
7     """Multiline
8     method docstring
9     """
10     pass
11
12
13 def foo():
14   """This is a docstring with             
15   some lines of text here
16   """
17   return
18
19
20 def bar():
21   '''This is another docstring
22   with more lines of text
23   '''
24   return
25
26
27 def baz():
28   '''"This" is a string with some
29   embedded "quotes"'''
30   return
31
32
33 def troz():
34         '''Indentation with tabs
35         is just as OK
36         '''
37         return
38
39
40 def zort():
41         """Another
42         multiline
43         docstring
44         """
45         pass
46
47 def poit():
48   """
49   Lorem ipsum dolor sit amet.       
50
51   Consectetur adipiscing elit:
52    - sed do eiusmod tempor incididunt ut labore
53    - dolore magna aliqua
54      - enim ad minim veniam
55      - quis nostrud exercitation ullamco laboris nisi
56    - aliquip ex ea commodo consequat
57   """
58   pass
59
60
61 def under_indent():
62   """
63   These lines are indented in a way that does not
64 make sense.
65   """
66   pass
67
68
69 def over_indent():
70   """
71   This has a shallow indent
72     - But some lines are deeper
73     - And the closing quote is too deep
74     """
75   pass
76
77
78 def single_line():
79     """But with a newline after it!
80
81     """
82     pass
83
84
85 def this():
86     r"""
87     'hey ho'
88     """
89
90
91 def that():
92   """ "hey yah" """
93
94
95 def and_that():
96   """
97   "hey yah" """
98
99
100 def and_this():
101   ''' 
102   "hey yah"'''
103
104
105 def empty():
106     '''
107     
108     
109     
110     
111     '''
112
113
114 def oneline_empty():
115     '''      '''
116
117
118 def oneline_nothing():
119     """"""
120
121
122 def single_quotes():
123     'testing'
124
125
126 def believe_it_or_not_this_is_in_the_py_stdlib(): ''' 
127 "hey yah"'''
128
129
130 def ignored_docstring():
131     """a => \
132 b"""  
133
134 def single_line_docstring_with_whitespace():
135     """   This should be stripped """
136
137 def docstring_with_inline_tabs_and_space_indentation():
138     """hey
139
140     tab separated       value
141         tab at start of line and then a tab     separated       value
142                                 multiple tabs at the beginning  and     inline
143                         mixed tabs and spaces at beginning. next line has mixed tabs and spaces only.
144                                                 
145     line ends with some tabs            
146     """
147
148
149 def docstring_with_inline_tabs_and_tab_indentation():
150         """hey
151
152         tab     separated       value
153                 tab at start of line and then a tab     separated       value
154                                         multiple tabs at the beginning  and     inline
155                                 mixed tabs and spaces at beginning. next line has mixed tabs and spaces only.
156                                                         
157         line ends with some tabs                
158         """
159         pass
160
161
162 def backslash_space():
163     """\ """
164
165
166 def multiline_backslash_1():
167   '''
168   hey\there\
169   \ '''
170
171
172 def multiline_backslash_2():
173   '''
174   hey there \ '''
175
176
177 # output
178
179 class MyClass:
180     """Multiline
181     class docstring
182     """
183
184     def method(self):
185         """Multiline
186         method docstring
187         """
188         pass
189
190
191 def foo():
192     """This is a docstring with
193     some lines of text here
194     """
195     return
196
197
198 def bar():
199     """This is another docstring
200     with more lines of text
201     """
202     return
203
204
205 def baz():
206     '''"This" is a string with some
207     embedded "quotes"'''
208     return
209
210
211 def troz():
212     """Indentation with tabs
213     is just as OK
214     """
215     return
216
217
218 def zort():
219     """Another
220     multiline
221     docstring
222     """
223     pass
224
225
226 def poit():
227     """
228     Lorem ipsum dolor sit amet.
229
230     Consectetur adipiscing elit:
231      - sed do eiusmod tempor incididunt ut labore
232      - dolore magna aliqua
233        - enim ad minim veniam
234        - quis nostrud exercitation ullamco laboris nisi
235      - aliquip ex ea commodo consequat
236     """
237     pass
238
239
240 def under_indent():
241     """
242       These lines are indented in a way that does not
243     make sense.
244     """
245     pass
246
247
248 def over_indent():
249     """
250     This has a shallow indent
251       - But some lines are deeper
252       - And the closing quote is too deep
253     """
254     pass
255
256
257 def single_line():
258     """But with a newline after it!"""
259     pass
260
261
262 def this():
263     r"""
264     'hey ho'
265     """
266
267
268 def that():
269     """ "hey yah" """
270
271
272 def and_that():
273     """
274     "hey yah" """
275
276
277 def and_this():
278     '''
279     "hey yah"'''
280
281
282 def empty():
283     """ """
284
285
286 def oneline_empty():
287     """ """
288
289
290 def oneline_nothing():
291     """ """
292
293
294 def single_quotes():
295     "testing"
296
297
298 def believe_it_or_not_this_is_in_the_py_stdlib():
299     '''
300     "hey yah"'''
301
302
303 def ignored_docstring():
304     """a => \
305 b"""
306
307
308 def single_line_docstring_with_whitespace():
309     """This should be stripped"""
310
311
312 def docstring_with_inline_tabs_and_space_indentation():
313     """hey
314
315     tab separated       value
316         tab at start of line and then a tab     separated       value
317                                 multiple tabs at the beginning  and     inline
318                         mixed tabs and spaces at beginning. next line has mixed tabs and spaces only.
319
320     line ends with some tabs
321     """
322
323
324 def docstring_with_inline_tabs_and_tab_indentation():
325     """hey
326
327     tab separated       value
328             tab at start of line and then a tab separated       value
329                                     multiple tabs at the beginning      and     inline
330                             mixed tabs and spaces at beginning. next line has mixed tabs and spaces only.
331
332     line ends with some tabs
333     """
334     pass
335
336
337 def backslash_space():
338     """\ """
339
340
341 def multiline_backslash_1():
342     """
343   hey\there\
344   \ """
345
346
347 def multiline_backslash_2():
348     """
349     hey there \ """