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