Skip to content

Commit 741eb42

Browse files
deruyter92deruyter92
committed
docs: convert docstrings to Google style (batch B4)
1 parent fd68cb0 commit 741eb42

4 files changed

Lines changed: 237 additions & 316 deletions

File tree

‎deeplabcut/create_project/demo_data.py‎

Lines changed: 9 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -25,21 +25,16 @@ def load_demo_data(
2525
"""Loads the demo data -- subset from trail-tracking data in Mathis et al. 2018.
2626
When loading, it sets paths correctly to run this project on your system.
2727
28-
Parameter
29-
----------
30-
config : string
31-
Full path of the config.yaml file of the provided demo dataset as a string.
28+
Args:
29+
config (string): Full path of the config.yaml file of the provided demo dataset
30+
as a string.
31+
createtrainingset (bool): Boolean variable indicating if a training set shall be
32+
created.
33+
engine (Engine): The Engine to create the training set for if a training set
34+
shall be created.
3235
33-
createtrainingset : bool
34-
Boolean variable indicating if a training set shall be created.
35-
36-
engine: Engine
37-
The Engine to create the training set for if a training set shall be created.
38-
39-
Example:
40-
--------
41-
>>> deeplabcut.load_demo_data("config.yaml")
42-
--------
36+
Examples:
37+
>>> deeplabcut.load_demo_data("config.yaml")
4338
"""
4439
config = Path(config).resolve()
4540
config = str(config)

0 commit comments

Comments
 (0)