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 single_quotes():
 119     'testing'
 120
 121
 122 def believe_it_or_not_this_is_in_the_py_stdlib(): '''
 123 "hey yah"'''
 124
 125
 126 def ignored_docstring():
 127     """a => \
 128 b"""
 129
 130 def single_line_docstring_with_whitespace():
 131     """   This should be stripped """
 132
 133 def docstring_with_inline_tabs_and_space_indentation():
 134     """hey
 135
 136     tab separated       value
 137         tab at start of line and then a tab     separated       value
 138                                 multiple tabs at the beginning  and     inline
 139                         mixed tabs and spaces at beginning. next line has mixed tabs and spaces only.
 140
 141     line ends with some tabs
 142     """
 143
 144
 145 def docstring_with_inline_tabs_and_tab_indentation():
 146         """hey
 147
 148         tab     separated       value
 149                 tab at start of line and then a tab     separated       value
 150                                         multiple tabs at the beginning  and     inline
 151                                 mixed tabs and spaces at beginning. next line has mixed tabs and spaces only.
 152
 153         line ends with some tabs
 154         """
 155         pass
 156
 157 # output
 158
 159 class MyClass:
 160     """Multiline
 161     class docstring
 162     """
 163
 164     def method(self):
 165         """Multiline
 166         method docstring
 167         """
 168         pass
 169
 170
 171 def foo():
 172     """This is a docstring with
 173     some lines of text here
 174     """
 175     return
 176
 177
 178 def bar():
 179     """This is another docstring
 180     with more lines of text
 181     """
 182     return
 183
 184
 185 def baz():
 186     '''"This" is a string with some
 187     embedded "quotes"'''
 188     return
 189
 190
 191 def troz():
 192     """Indentation with tabs
 193     is just as OK
 194     """
 195     return
 196
 197
 198 def zort():
 199     """Another
 200     multiline
 201     docstring
 202     """
 203     pass
 204
 205
 206 def poit():
 207     """
 208     Lorem ipsum dolor sit amet.
 209
 210     Consectetur adipiscing elit:
 211      - sed do eiusmod tempor incididunt ut labore
 212      - dolore magna aliqua
 213        - enim ad minim veniam
 214        - quis nostrud exercitation ullamco laboris nisi
 215      - aliquip ex ea commodo consequat
 216     """
 217     pass
 218
 219
 220 def under_indent():
 221     """
 222       These lines are indented in a way that does not
 223     make sense.
 224     """
 225     pass
 226
 227
 228 def over_indent():
 229     """
 230     This has a shallow indent
 231       - But some lines are deeper
 232       - And the closing quote is too deep
 233     """
 234     pass
 235
 236
 237 def single_line():
 238     """But with a newline after it!"""
 239     pass
 240
 241
 242 def this():
 243     r"""
 244     'hey ho'
 245     """
 246
 247
 248 def that():
 249     """ "hey yah" """
 250
 251
 252 def and_that():
 253     """
 254     "hey yah" """
 255
 256
 257 def and_this():
 258     '''
 259     "hey yah"'''
 260
 261
 262 def empty():
 263     """ """
 264
 265
 266 def oneline_empty():
 267     """ """
 268
 269
 270 def single_quotes():
 271     "testing"
 272
 273
 274 def believe_it_or_not_this_is_in_the_py_stdlib():
 275     '''
 276     "hey yah"'''
 277
 278
 279 def ignored_docstring():
 280     """a => \
 281 b"""
 282
 283
 284 def single_line_docstring_with_whitespace():
 285     """This should be stripped"""
 286
 287
 288 def docstring_with_inline_tabs_and_space_indentation():
 289     """hey
 290
 291     tab separated       value
 292         tab at start of line and then a tab     separated       value
 293                                 multiple tabs at the beginning  and     inline
 294                         mixed tabs and spaces at beginning. next line has mixed tabs and spaces only.
 295
 296     line ends with some tabs
 297     """
 298
 299
 300 def docstring_with_inline_tabs_and_tab_indentation():
 301     """hey
 302
 303     tab separated       value
 304             tab at start of line and then a tab separated       value
 305                                     multiple tabs at the beginning      and     inline
 306                             mixed tabs and spaces at beginning. next line has mixed tabs and spaces only.
 307
 308     line ends with some tabs
 309     """
 310     pass