Skip to content

Commit 35a0c90

Browse files
committed
Updated docs.
1 parent 05ed57c commit 35a0c90

File tree

2 files changed

+1
-7
lines changed

2 files changed

+1
-7
lines changed

doc-source/api/paths.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,3 +4,4 @@
44

55
.. automodule:: domdf_python_tools.paths
66
:undoc-members:
7+
:exclude-members: __enter__,__exit__

domdf_python_tools/paths.py

Lines changed: 0 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -116,7 +116,6 @@ def copytree(
116116
the copy process. You can set the optional ignore_dangling_symlinks
117117
flag to true if you want to silence this exception. Notice that this
118118
option has no effect on platforms that don’t support :class:`python:os.symlink`.
119-
:type symlinks: bool, optional
120119
:param ignore: A callable that will receive as its arguments the source
121120
directory, and a list of its contents. The ignore callable will be
122121
called once for each directory that is copied. The callable must return
@@ -162,18 +161,15 @@ def maybe_make(directory: PathLike, mode: int = 0o777, parents: bool = False, ex
162161
163162
:param directory: Directory to create
164163
:param mode: Combined with the process’ umask value to determine the file mode and access flags
165-
:type mode:
166164
:param parents: If :py:obj:`False` (the default), a missing parent raises a :class:`~python:FileNotFoundError`.
167165
If :py:obj:`True`, any missing parents of this path are created as needed; they are created with the
168166
default permissions without taking mode into account (mimicking the POSIX mkdir -p command).
169167
:no-default parents:
170-
:type parents: bool, optional
171168
:param exist_ok: If :py:obj:`False` (the default), a :class:`~python:FileExistsError` is raised if the
172169
target directory already exists. If :py:obj:`True`, :class:`~python:FileExistsError` exceptions
173170
will be ignored (same behavior as the POSIX mkdir -p command), but only if the last path
174171
component is not an existing non-directory file.
175172
:no-default exist_ok:
176-
:type exist_ok: bool, optional
177173
"""
178174

179175
if not isinstance(directory, pathlib.Path):
@@ -383,13 +379,11 @@ def maybe_make(
383379
If :py:obj:`True`, any missing parents of this path are created as needed; they are created with the
384380
default permissions without taking mode into account (mimicking the POSIX mkdir -p command).
385381
:no-default parents:
386-
:type parents: bool, optional
387382
:param exist_ok: If :py:obj:`False` (the default), a :class:`~python:FileExistsError` is raised if the
388383
target directory already exists. If :py:obj:`True`, :class:`~python:FileExistsError` exceptions
389384
will be ignored (same behavior as the POSIX mkdir -p command), but only if the last path
390385
component is not an existing non-directory file.
391386
:no-default exist_ok:
392-
:type exist_ok: bool, optional
393387
394388
:rtype:
395389
@@ -450,7 +444,6 @@ def write_lines(
450444
and close the file.
451445
452446
:param data:
453-
:type data: str
454447
:param encoding: The encoding to write to the file using.
455448
:param errors:
456449

0 commit comments

Comments
 (0)