File: format_sphinx.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 (285 lines) | stat: -rw-r--r-- 8,563 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
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
[sphinx]
instring='''"""Return line-wrapped description text.

    We only wrap simple descriptions. We leave doctests, multi-paragraph text, and bulleted lists alone.  See http://www.docformatter.com/.

    :param str text: the text argument.
    :param str indentation: the super long description for the indentation argument that will require docformatter to wrap this line.
    :param int wrap_length: the wrap_length argument
    :param bool force_wrap: the force_warp argument.
    :return: really long description text wrapped at n characters and a very long description of the return value so we can wrap this line abcd efgh ijkl mnop qrst uvwx yz.
    :rtype: str
"""'''
outstring='''"""Return line-wrapped description text.

    We only wrap simple descriptions. We leave doctests, multi-paragraph text, and
    bulleted lists alone.  See
    http://www.docformatter.com/.

    :param str text: the text argument.
    :param str indentation: the super long description for the indentation argument that
        will require docformatter to wrap this line.
    :param int wrap_length: the wrap_length argument
    :param bool force_wrap: the force_warp argument.
    :return: really long description text wrapped at n characters and a very long
        description of the return value so we can wrap this line abcd efgh ijkl mnop
        qrst uvwx yz.
    :rtype: str
    """'''

[sphinx.numpy]
instring='''"""Return line-wrapped description text.

    We only wrap simple descriptions. We leave doctests, multi-paragraph text, and bulleted lists alone.  See http://www.docformatter.com/.

    :param str text: the text argument.
    :param str indentation: the super long description for the indentation argument that will require docformatter to wrap this line.
    :param int wrap_length: the wrap_length argument
    :param bool force_wrap: the force_warp argument.
    :return: really long description text wrapped at n characters and a very long description of the return value so we can wrap this line abcd efgh ijkl mnop qrst uvwx yz.
    :rtype: str
"""'''
outstring='''"""Return line-wrapped description text.

    We only wrap simple descriptions. We leave doctests, multi-paragraph text, and
    bulleted lists alone.  See
    http://www.docformatter.com/.

    :param str text: the text argument.
    :param str indentation: the super long description for the indentation argument that will require docformatter to wrap this line.
    :param int wrap_length: the wrap_length argument
    :param bool force_wrap: the force_warp argument.
    :return: really long description text wrapped at n characters and a very long description of the return value so we can wrap this line abcd efgh ijkl mnop qrst uvwx yz.
    :rtype: str
    """'''

[issue_215]
instring='''"""Create or return existing HTTP session.

    :return: Requests :class:`~requests.Session` object
    """'''
outstring='''"""Create or return existing HTTP session.

    :return: Requests :class:`~requests.Session` object
    """'''

[issue_217_222]
instring='''"""Base for all Commands.

:param logger: Logger for console and logfile.
:param console: Facilitates console interaction and input solicitation.
:param tools: Cache of tools populated by Commands as they are required.
:param apps: Dictionary of project's Apps keyed by app name.
:param base_path: Base directory for Briefcase project.
:param data_path: Base directory for Briefcase tools, support packages, etc.
:param is_clone: Flag that Command was triggered by the user's requested Command;
    for instance, RunCommand can invoke UpdateCommand and/or BuildCommand.
"""'''
outstring='''"""Base for all Commands.

    :param logger: Logger for console and logfile.
    :param console: Facilitates console interaction and input solicitation.
    :param tools: Cache of tools populated by Commands as they are required.
    :param apps: Dictionary of project's Apps keyed by app name.
    :param base_path: Base directory for Briefcase project.
    :param data_path: Base directory for Briefcase tools, support packages, etc.
    :param is_clone: Flag that Command was triggered by the user's requested Command;
        for instance, RunCommand can invoke UpdateCommand and/or BuildCommand.
    """'''

[issue_224]
instring='''"""
Add trackers to a torrent.

:raises NotFound404Error:

:param torrent_hash: hash for torrent
:param urls: tracker URLs to add to torrent
:return: None
"""'''
outstring='''"""Add trackers to a torrent.

    :raises NotFound404Error:

    :param torrent_hash: hash for torrent
    :param urls: tracker URLs to add to torrent
    :return: None
    """'''

[issue_228]
instring='''"""Configure application requirements by writing a requirements.txt file.

    :param app: The app configuration
    :param requires: The full list of requirements
    :param requirements_path: The full path to a requirements.txt file that
        will be written.
    """'''
outstring='''"""Configure application requirements by writing a requirements.txt file.

    :param app: The app configuration
    :param requires: The full list of requirements
    :param requirements_path: The full path to a requirements.txt file that will be
        written.
    """'''

[issue_229]
instring='''"""CC.

    :meth:`!X`
    """'''
outstring='''"""CC.

    :meth:`!X`
    """'''

[issue_229_2]
instring='''"""CC.

    :math: `-`
    """'''
outstring='''"""CC.

    :math: `-`
    """'''

[issue_230]
instring='''"""CC.

    :math:`-`
    :param d: blabla
    :param list(str) l: more blabla.
    """'''
outstring= '''"""CC.

    :math:`-`
    :param d: blabla
    :param list(str) l: more blabla.
    """'''

[issue_232]
instring='''def function:
    """
    :param x: X
    :param y: Y
    """'''
outstring='''def function:
    """
    :param x: X
    :param y: Y
    """'''

[issue_234]
instring=''' """CC.

    :math:`f(0) = 1`. XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX XXXXXXXXXXXXXXXXXXXXXX
    """'''
outstring='''"""CC.

    :math:`f(0) = 1`. XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX XXXXXXXXXXXXXXXXXXXXXX
    """'''

[issue_235]
instring='''"""CC.

    C.

    C,
    :math:`[0, 1]`.
"""'''
outstring='''"""CC.

    C.

    C, :math:`[0, 1]`.
    """'''

[issue_239]
instring='''"""
Summary.

    :raises InvalidRequest400Error:
    :raises NotFound404Error:
    :raises Conflict409Error:

    :param param: asdf
    """'''
outstring='''"""Summary.

    :raises InvalidRequest400Error:
    :raises NotFound404Error:
    :raises Conflict409Error:

    :param param: asdf
    """'''

[issue_245]
instring='''"""Some f.
    :param a: Some param.
    :raises my.package.MyReallySrsError: Bad things happened.
    """'''
outstring='''"""Some f.

    :param a: Some param.
    :raises my.package.MyReallySrsError: Bad things happened.
    """'''

[issue_250]
instring=''' """CC.

    c.

    c c :math:`[0, 1]`.
    """'''
outstring='''"""CC.

    c.

    c c :math:`[0, 1]`.
    """'''

[issue_253]
instring='''"""
    My test fixture.

    :param caplog: Pytest caplog fixture.
    :yield: Until test complete, then run cleanup.
    """'''
outstring='''"""
    My test fixture.

    :param caplog: Pytest caplog fixture.
    :yield: Until test complete, then run cleanup.
    """'''

[issue_271]
instring='''"""
    My test fixture.

    :ivar id: A unique identifier for the element, automatically generated upon instantiation.
    :vartype id: str
    :ivar created: Timestamp when the element was created, defaults to the current time.
    :vartype created: datetime
    :cvar modified: Timestamp when the element was last modified, can be None if not modified.
    :vartype modified: Optional[datetime]
    :cvar in_project: List of projects this element is part of. Direct modification is restricted.
    :vartype in_project: list[Project]
    :param caplog: Pytest caplog fixture.
    :yield: Until test complete, then run cleanup.
    """'''
outstring='''"""
    My test fixture.

    :ivar id: A unique identifier for the element, automatically generated upon
        instantiation.
    :vartype id: str
    :ivar created: Timestamp when the element was created, defaults to the current time.
    :vartype created: datetime
    :cvar modified: Timestamp when the element was last modified, can be None if not
        modified.
    :vartype modified: Optional[datetime]
    :cvar in_project: List of projects this element is part of. Direct modification is
        restricted.
    :vartype in_project: list[Project]
    :param caplog: Pytest caplog fixture.
    :yield: Until test complete, then run cleanup.
    """'''