💄style(project): turn all restructure docstrings into google docstrings
This commit is contained in:
+10
-2
@@ -16,7 +16,9 @@ def version_callback(value: bool):
|
|||||||
"""
|
"""
|
||||||
Print the version of package.
|
Print the version of package.
|
||||||
Stop the CLI after printing version.
|
Stop the CLI after printing version.
|
||||||
:return:
|
|
||||||
|
Args:
|
||||||
|
value: True if '--version' is provided, False otherwise.
|
||||||
"""
|
"""
|
||||||
if value:
|
if value:
|
||||||
print(f"logwatcher version: {__version__}")
|
print(f"logwatcher version: {__version__}")
|
||||||
@@ -26,7 +28,13 @@ def version_callback(value: bool):
|
|||||||
def _is_log_file(path: Path) -> bool:
|
def _is_log_file(path: Path) -> bool:
|
||||||
"""
|
"""
|
||||||
Return True if file is a log file (.txt, .log, or extensionless).
|
Return True if file is a log file (.txt, .log, or extensionless).
|
||||||
:param path: Path to log file
|
|
||||||
|
Args:
|
||||||
|
path: Path of a file
|
||||||
|
|
||||||
|
Returns:
|
||||||
|
True if file has .txt or .log extension or extensionless
|
||||||
|
False otherwise.
|
||||||
"""
|
"""
|
||||||
if not path.is_file():
|
if not path.is_file():
|
||||||
return False
|
return False
|
||||||
|
|||||||
Reference in New Issue
Block a user