Skip to content

Commit

Permalink
Update docstrings formatting
Browse files Browse the repository at this point in the history
  • Loading branch information
ashleve committed Jun 9, 2022
1 parent 5fc170c commit 8f99349
Showing 1 changed file with 5 additions and 5 deletions.
10 changes: 5 additions & 5 deletions pyrootutils/pyrootutils.py
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ def find_root(
Args:
search_from (str): Path to folder or file to start search from.
indicator (Union[str, Iterable[str]], optional): List of filenames to search for. Finding at least one on these files indicates the project root.
indicator (Union[str, Iterable[str]], optional): List of filenames to search for. Finding at least one on these files indicates the project root.
Raises:
TypeError: If any input type is incorrect.
Expand Down Expand Up @@ -130,21 +130,21 @@ def setup_root(
cwd: bool = False,
) -> Path:
"""Combines `get_root()` and `set_root()` into one method.
Recursively searches for files from the `indicators` list, starting from given path.
Args:
search_from (str): Path to file or folder to start search from.
indicator (Union[str, Iterable[str]], optional): List of filenames to search for. Finding at least one on these files indicates the project root.
indicator (Union[str, Iterable[str]], optional): List of filenames to search for. Finding at least one on these files indicates the project root.
project_root_env_var (bool, optional): Whether to set PROJECT_ROOT environment variable.
dotenv (bool, optional): Whether to load `.env` file from project root.
pythonpath (bool, optional): Whether to add project root to pythonpath.
cwd (bool, optional): Whether to set current working directory to project root.
Raises:
TypeError: If any input type is incorrect.
FileNotFoundError: If root is not found.
Returns:
Path: Path to project root.
"""
Expand Down

0 comments on commit 8f99349

Please sign in to comment.