Skip to content

Commit aa21d83

Browse files
committed
Configure darglint to assume native Sphinx syntax
1 parent c121864 commit aa21d83

File tree

2 files changed

+26
-9
lines changed

2 files changed

+26
-9
lines changed

.darglint

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
[darglint]
2+
# NOTE: All `darglint` styles except for `sphinx` hit ridiculously low
3+
# NOTE: performance on some of the in-project Python modules.
4+
# Refs:
5+
# * https://github.com/terrencepreilly/darglint/issues/186
6+
# * https://github.com/wemake-services/wemake-python-styleguide/issues/2287
7+
docstring_style = sphinx
8+
strictness = full

cheroot/server.py

Lines changed: 18 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -277,7 +277,8 @@ def _check_length(self):
277277
def read(self, size=None):
278278
"""Read a chunk from ``rfile`` buffer and return it.
279279
280-
:param int size: amount of data to read
280+
:param size: amount of data to read
281+
:type size: int
281282
282283
:returns: chunk from ``rfile``, limited by size if specified
283284
:rtype: bytes
@@ -290,7 +291,8 @@ def read(self, size=None):
290291
def readline(self, size=None):
291292
"""Read a single line from ``rfile`` buffer and return it.
292293
293-
:param int size: minimum amount of data to read
294+
:param size: minimum amount of data to read
295+
:type size: int
294296
295297
:returns: one line from ``rfile``
296298
:rtype: bytes
@@ -316,7 +318,8 @@ def readline(self, size=None):
316318
def readlines(self, sizehint=0):
317319
"""Read all lines from ``rfile`` buffer and return them.
318320
319-
:param int sizehint: hint of minimum amount of data to read
321+
:param sizehint: hint of minimum amount of data to read
322+
:type sizehint: int
320323
321324
:returns: lines of bytes read from ``rfile``
322325
:rtype: list[bytes]
@@ -366,7 +369,8 @@ def __init__(self, rfile, content_length):
366369
def read(self, size=None):
367370
"""Read a chunk from ``rfile`` buffer and return it.
368371
369-
:param int size: amount of data to read
372+
:param size: amount of data to read
373+
:type size: int
370374
371375
:rtype: bytes
372376
:returns: chunk from ``rfile``, limited by size if specified
@@ -385,7 +389,8 @@ def read(self, size=None):
385389
def readline(self, size=None):
386390
"""Read a single line from ``rfile`` buffer and return it.
387391
388-
:param int size: minimum amount of data to read
392+
:param size: minimum amount of data to read
393+
:type size: int
389394
390395
:returns: one line from ``rfile``
391396
:rtype: bytes
@@ -404,7 +409,8 @@ def readline(self, size=None):
404409
def readlines(self, sizehint=0):
405410
"""Read all lines from ``rfile`` buffer and return them.
406411
407-
:param int sizehint: hint of minimum amount of data to read
412+
:param sizehint: hint of minimum amount of data to read
413+
:type sizehint: int
408414
409415
:returns: lines of bytes read from ``rfile``
410416
:rtype: list[bytes]
@@ -505,7 +511,8 @@ def _fetch(self):
505511
def read(self, size=None):
506512
"""Read a chunk from ``rfile`` buffer and return it.
507513
508-
:param int size: amount of data to read
514+
:param size: amount of data to read
515+
:type size: int
509516
510517
:returns: chunk from ``rfile``, limited by size if specified
511518
:rtype: bytes
@@ -536,7 +543,8 @@ def read(self, size=None):
536543
def readline(self, size=None):
537544
"""Read a single line from ``rfile`` buffer and return it.
538545
539-
:param int size: minimum amount of data to read
546+
:param size: minimum amount of data to read
547+
:type size: int
540548
541549
:returns: one line from ``rfile``
542550
:rtype: bytes
@@ -577,7 +585,8 @@ def readline(self, size=None):
577585
def readlines(self, sizehint=0):
578586
"""Read all lines from ``rfile`` buffer and return them.
579587
580-
:param int sizehint: hint of minimum amount of data to read
588+
:param sizehint: hint of minimum amount of data to read
589+
:type sizehint: int
581590
582591
:returns: lines of bytes read from ``rfile``
583592
:rtype: list[bytes]

0 commit comments

Comments
 (0)