Skip to content

Commit 780755c

Browse files
committed
Updated some docstrings
1 parent fdb8d8d commit 780755c

File tree

1 file changed

+4
-6
lines changed

1 file changed

+4
-6
lines changed

domdf_python_tools/paths.py

Lines changed: 4 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -61,7 +61,7 @@ def append(var: str, filename: PathLike, **kwargs) -> int:
6161
6262
This is currently untested
6363
64-
TODO: make this the file in the given directory, by default the current directory
64+
.. TODO:: make this the file in the given directory, by default the current directory
6565
6666
:param var: The value to append to the file
6767
:param filename: The file to append to
@@ -119,7 +119,7 @@ def delete(filename: PathLike, **kwargs):
119119
120120
This is currently untested
121121
122-
TODO: make this the file in the given directory, by default the current directory
122+
.. TODO:: make this the file in the given directory, by default the current directory
123123
124124
:param filename: The file to delete
125125
"""
@@ -175,16 +175,14 @@ def read(filename: PathLike, **kwargs) -> str:
175175
176176
This is currently untested
177177
178-
TODO: make this the file in the given directory, by default the current directory
178+
.. TODO:: make this the file in the given directory, by default the current directory
179179
180180
:param filename: The file to read from
181181
182182
:return: The contents of the file
183183
:rtype: str
184184
"""
185185

186-
# TODO: docstring
187-
188186
with open(os.path.join(os.getcwd(), filename), **kwargs) as f:
189187
return f.read()
190188

@@ -227,7 +225,7 @@ def write(var: str, filename: PathLike, **kwargs) -> None:
227225
"""
228226
Write a variable to file in the current directory.
229227
230-
TODO: make this the file in the given directory, by default the current directory
228+
.. TODO:: make this the file in the given directory, by default the current directory
231229
232230
:param var: The value to write to the file
233231
:param filename: The file to write to

0 commit comments

Comments
 (0)