Skip to content

Commit 2325a29

Browse files
committed
Update docs.
1 parent 073a018 commit 2325a29

File tree

3 files changed

+18
-5
lines changed

3 files changed

+18
-5
lines changed

domdf_python_tools/doctools.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -311,7 +311,7 @@ def _do_prettify(obj: Type, base: Type, new_docstrings: Dict[str, str]):
311311
:param base:
312312
:param new_docstrings:
313313
314-
:return:
314+
:rtype:
315315
316316
.. versionadded:: 0.8.0
317317
"""

domdf_python_tools/paths.py

Lines changed: 11 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -307,10 +307,12 @@ def __new__(cls, *args, **kwargs):
307307
self._init()
308308
return self
309309

310-
def make_executable(self):
310+
def make_executable(self) -> None:
311311
"""
312312
Make the file executable.
313313
314+
:rtype:
315+
314316
.. versionadded:: 0.3.8
315317
"""
316318

@@ -329,6 +331,8 @@ def write_clean(
329331
:param encoding: The encoding to write to the file using.
330332
:param errors:
331333
334+
:rtype:
335+
332336
.. versionadded:: 0.3.8
333337
"""
334338

@@ -350,7 +354,6 @@ def maybe_make(
350354
This appears to be due to the behaviour of :func:`os.mkdir`.
351355
352356
:param mode: Combined with the process’ umask value to determine the file mode and access flags
353-
:type mode:
354357
:param parents: If :py:obj:`False` (the default), a missing parent raises a :class:`~python:FileNotFoundError`.
355358
If :py:obj:`True`, any missing parents of this path are created as needed; they are created with the
356359
default permissions without taking mode into account (mimicking the POSIX mkdir -p command).
@@ -363,6 +366,8 @@ def maybe_make(
363366
:no-default exist_ok:
364367
:type exist_ok: bool, optional
365368
369+
:rtype:
370+
366371
.. versionadded:: 0.3.8
367372
"""
368373

@@ -378,10 +383,11 @@ def append_text(
378383
Open the file in text mode, append the given string to it, and close the file.
379384
380385
:param string:
381-
:type string: str
382386
:param encoding: The encoding to write to the file using.
383387
:param errors:
384388
389+
:rtype:
390+
385391
.. versionadded:: 0.3.8
386392
"""
387393

@@ -398,10 +404,11 @@ def write_text(
398404
Open the file in text mode, write to it, and close the file.
399405
400406
:param data:
401-
:type data: str
402407
:param encoding: The encoding to write to the file using.
403408
:param errors:
404409
410+
:rtype:
411+
405412
.. versionadded:: 0.3.8
406413
"""
407414

domdf_python_tools/testing.py

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -190,6 +190,8 @@ def whitespace_perms(ratio: float = 0.5) -> MarkDecorator:
190190
191191
:param ratio: The ratio of the number of permutations to select to the total number of permutations.
192192
193+
:rtype:
194+
193195
.. versionadded:: 0.4.9
194196
""" # noqa D400
195197

@@ -208,6 +210,8 @@ def count(stop: int, start: int = 0, step: int = 1) -> MarkDecorator:
208210
:param start: The start value passed to :class:`range`.
209211
:param step: The step passed to :class:`range`.
210212
213+
:rtype:
214+
211215
.. versionadded:: 0.4.9
212216
""" # noqa D400
213217

@@ -258,6 +262,8 @@ def max_version(
258262
:param reason: The reason to display when skipping.
259263
:default reason: ``'Not needed after Python <version>.'``
260264
265+
:rtype:
266+
261267
.. versionadded:: 0.9.0
262268
""" # noqa D400
263269

0 commit comments

Comments
 (0)