File: do_format_docstrings.toml

package info (click to toggle)
python-docformatter 1.7.7-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 1,156 kB
  • sloc: python: 6,180; makefile: 28; sh: 7
file content (241 lines) | stat: -rw-r--r-- 4,896 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
[one_line]
instring='''"""

Hello.
"""'''
outstring='''"""Hello."""'''

[summary_end_quote]
instring='''"""

"Hello"
"""'''
outstring='''""""Hello"."""'''

[bad_indentation]
instring='''"""Hello.

 This should be indented but it is not. The
 next line should be indented too. And
 this too.
"""'''
outstring='''"""Hello.

    This should be indented but it is not.
    The next line should be indented too.
    And this too.
    """'''

[too_much_indentation]
instring='''"""Hello.

        This should be dedented.

        1. This too.
        2. And this.
        3. And this.

    """'''
outstring='''"""Hello.

    This should be dedented.

    1. This too.
    2. And this.
    3. And this.
    """'''

[trailing_whitespace]
instring='''"""Hello.	
	
    This should be not have trailing whitespace. The			
    next line should not have trailing whitespace either.	
	
    """'''
outstring='''"""Hello.

    This should be not have trailing whitespace. The
    next line should not have trailing whitespace
    either.
    """'''

[empty_docstring]
instring='''""""""'''
outstring='''""""""'''

[no_summary_period]
instring='''"""

Hello
"""'''
outstring='''"""Hello."""'''

[single_quotes]
instring="""'''

Hello.
'''"""
outstring='''"""Hello."""'''

[single_quotes_multiline]
instring="""'''
    Return x factorial.

    This uses math.factorial.
    '''"""
outstring='''"""Return x factorial.

    This uses math.factorial.
    """'''

[skip_underlined_summary]
instring='''"""
    Foo bar
    -------

    This is more.

    """'''
outstring='''"""
    Foo bar
    -------

    This is more.

    """'''

[issue_156]
instring='''class AcceptHeader(ExtendedSchemaNode):
        # ok to use name in this case because target key in the mapping must
        # be that specific value but cannot have a field named with this format
        name = "Accept"
        schema_type = String
        missing = drop
        default = ContentType.APP_JSON  # defaults to JSON for easy use within browsers


    class AcceptLanguageHeader(ExtendedSchemaNode):
        # ok to use name in this case because target key in the mapping must
        # be that specific value but cannot have a field named with this format
        name = "Accept-Language"
        schema_type = String
        missing = drop
        default = AcceptLanguage.EN_CA
        # FIXME: oneOf validator for supported languages (?)'''
outstring='''class AcceptHeader(ExtendedSchemaNode):
        # ok to use name in this case because target key in the mapping must
        # be that specific value but cannot have a field named with this format
        name = "Accept"
        schema_type = String
        missing = drop
        default = ContentType.APP_JSON  # defaults to JSON for easy use within browsers


    class AcceptLanguageHeader(ExtendedSchemaNode):
        # ok to use name in this case because target key in the mapping must
        # be that specific value but cannot have a field named with this format
        name = "Accept-Language"
        schema_type = String
        missing = drop
        default = AcceptLanguage.EN_CA
        # FIXME: oneOf validator for supported languages (?)'''

[issue_157]
instring='''""".. code-block:: shell-session

    ► apm --version
    apm  2.6.2
    npm  6.14.13
    node 12.14.1 x64
    atom 1.58.0
    python 2.7.16
    git 2.33.0
    """'''
outstring='''""".. code-block:: shell-session

    ► apm --version
    apm  2.6.2
    npm  6.14.13
    node 12.14.1 x64
    atom 1.58.0
    python 2.7.16
    git 2.33.0
    """'''

[issue_176]
instring='''def Class1:
    """Class.""" #noqa

    attribute
    """Attr."""


def Class2:
    """Class."""

    attribute
    """Attr."""


def Class3:
    """Class docstring.

    With long description.
    """    #noqa

    attribute
    """Attr."""'''
outstring='''def Class1:
    """Class.""" #noqa

    attribute
    """Attr."""


def Class2:
    """Class."""

    attribute
    """Attr."""


def Class3:
    """Class docstring.

    With long description.
    """    #noqa

    attribute
    """Attr."""'''

[issue_193]
instring='''"""
eBay kinda suss
"""'''
outstring='''"""eBay kinda suss."""'''

[issue_263]
[issue_263.sphinx]
# the `xx.\n\n` ensures there are a summary and a description sections
# the `:param a:` creates a field
# the `b`s create text that is long enough to trigger a line wrap without being so long that they count as code
# the `s3://cccc.` is a url
instring='''"""xx.

    :param a: bbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb s3://cccc.
"""'''
outstring='''"""xx.

    :param a: bbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb
        s3://cccc.
    """'''
[issue_263.epytext]
instring='''"""xx.

    @param a: bbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb s3://cccc.
    """'''
outstring='''"""xx.

    @param a: bbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb
        s3://cccc.
    """'''