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 over_indent():
  62   """
  63   This has a shallow indent
  64     - But some lines are deeper
  65     - And the closing quote is too deep
  66     """
  67   pass
  68
  69
  70 def single_line():
  71     """But with a newline after it!
  72
  73     """
  74     pass
  75
  76 # output
  77
  78 class MyClass:
  79     """Multiline
  80     class docstring
  81     """
  82
  83     def method(self):
  84         """Multiline
  85         method docstring
  86         """
  87         pass
  88
  89
  90 def foo():
  91     """This is a docstring with
  92     some lines of text here
  93     """
  94     return
  95
  96
  97 def bar():
  98     """This is another docstring
  99     with more lines of text
 100     """
 101     return
 102
 103
 104 def baz():
 105     '''"This" is a string with some
 106     embedded "quotes"'''
 107     return
 108
 109
 110 def troz():
 111     """Indentation with tabs
 112     is just as OK
 113     """
 114     return
 115
 116
 117 def zort():
 118     """Another
 119     multiline
 120     docstring
 121     """
 122     pass
 123
 124
 125 def poit():
 126     """
 127     Lorem ipsum dolor sit amet.
 128
 129     Consectetur adipiscing elit:
 130      - sed do eiusmod tempor incididunt ut labore
 131      - dolore magna aliqua
 132        - enim ad minim veniam
 133        - quis nostrud exercitation ullamco laboris nisi
 134      - aliquip ex ea commodo consequat
 135     """
 136     pass
 137
 138
 139 def over_indent():
 140     """
 141     This has a shallow indent
 142       - But some lines are deeper
 143       - And the closing quote is too deep
 144     """
 145     pass
 146
 147
 148 def single_line():
 149     """But with a newline after it!"""
 150     pass