Standardise docstring summary line placement.
This commit is contained in:
@@ -12,7 +12,8 @@ _LOGGER = getLogger(__name__)
|
||||
|
||||
|
||||
def run(overwrite_existing: bool = True):
|
||||
"""Resets the demo jupyter notebooks in the users app notebooks directory.
|
||||
"""
|
||||
Resets the demo jupyter notebooks in the users app notebooks directory.
|
||||
|
||||
:param overwrite_existing: A bool to toggle replacing existing edited notebooks on or off.
|
||||
"""
|
||||
|
||||
@@ -11,7 +11,8 @@ _LOGGER = getLogger(__name__)
|
||||
|
||||
|
||||
def run(overwrite_existing=True):
|
||||
"""Resets the example config files in the users app config directory.
|
||||
"""
|
||||
Resets the example config files in the users app config directory.
|
||||
|
||||
:param overwrite_existing: A bool to toggle replacing existing edited config on or off.
|
||||
"""
|
||||
|
||||
@@ -5,7 +5,8 @@ _LOGGER = getLogger(__name__)
|
||||
|
||||
|
||||
def run():
|
||||
"""Handles creation of application directories and user directories.
|
||||
"""
|
||||
Handles creation of application directories and user directories.
|
||||
|
||||
Uses `platformdirs.PlatformDirs` and `pathlib.Path` to create the required
|
||||
app directories in the correct locations based on the users OS.
|
||||
|
||||
Reference in New Issue
Block a user