Skip to content

Commit 996e364

Browse files
committed
Improve docstring for paths_to_modules.
1 parent 8689719 commit 996e364

File tree

1 file changed

+8
-2
lines changed

1 file changed

+8
-2
lines changed

importcheck/__init__.py

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -209,7 +209,9 @@ def check_module(module: str, combine_output: bool = False) -> Union[OK, Error]:
209209

210210
def paths_to_modules(*paths: PathLike) -> Iterator[str]:
211211
r"""
212-
Convert filesystem paths (e.g. ``foo/bar.py``) into dotted import names (e.g. ``foo.bar``).
212+
Convert filesystem paths into dotted import names.
213+
214+
For example, ``foo/bar.py`` becomes ``foo.bar``.
213215
214216
.. versionadded:: 0.3.0
215217
@@ -226,14 +228,18 @@ def paths_to_modules(*paths: PathLike) -> Iterator[str]:
226228

227229

228230
class ImportChecker:
229-
"""
231+
r"""
230232
Class for checking modules can be imported.
231233
232234
.. versionadded:: 0.3.0
233235
234236
:param modules: The list of modules to be checked.
235237
:param show: Whether to show stdout and stderr generated from imports.
236238
:param colour: Whether to use coloured output.
239+
240+
.. raw:: latex
241+
242+
\vspace{10px}
237243
"""
238244

239245
def __init__(

0 commit comments

Comments
 (0)