diff options
| author | Théo de la Hogue | 2024-04-10 17:05:36 +0200 |
|---|---|---|
| committer | Théo de la Hogue | 2024-04-10 17:05:36 +0200 |
| commit | 239f81d277a6b4a760c54f4c7ea11c6440856750 (patch) | |
| tree | 39bdf44bead5cfea5426e0e5abf21271dbd43340 | |
| parent | d6ad7c9a59ea500d1293f04d88bd8dfecf65380f (diff) | |
| download | argaze-239f81d277a6b4a760c54f4c7ea11c6440856750.zip argaze-239f81d277a6b4a760c54f4c7ea11c6440856750.tar.gz argaze-239f81d277a6b4a760c54f4c7ea11c6440856750.tar.bz2 argaze-239f81d277a6b4a760c54f4c7ea11c6440856750.tar.xz | |
Improving docstrings.
| -rw-r--r-- | src/argaze/DataFeatures.py | 12 | ||||
| -rw-r--r-- | src/argaze/__init__.py | 22 |
2 files changed, 17 insertions, 17 deletions
diff --git a/src/argaze/DataFeatures.py b/src/argaze/DataFeatures.py index c89fdea..a608540 100644 --- a/src/argaze/DataFeatures.py +++ b/src/argaze/DataFeatures.py @@ -111,14 +111,14 @@ def properties(cls) -> list: def from_json(filepath: str) -> any: """ - Load object instance from .json file. + Load object from json file. - !!! note - The directory where configuration file is will be the global working directory. + !!! note + The directory where json file is will be used as global working directory. - Parameters: - filepath: path to json configuration file - """ + Parameters: + filepath: path to json file + """ logging.debug('DataFeatures.from_json') diff --git a/src/argaze/__init__.py b/src/argaze/__init__.py index 7224a85..2e004f1 100644 --- a/src/argaze/__init__.py +++ b/src/argaze/__init__.py @@ -1,20 +1,20 @@ """ ArGaze is divided in submodules dedicated to various specifics features. """ -__all__ = ['ArUcoMarkers', 'AreaOfInterest', 'ArFeatures', 'GazeFeatures', 'GazeAnalysis', 'PupilFeatures', - 'PupilAnalysis', 'DataFeatures', 'utils'] +__all__ = ['ArUcoMarkers', 'AreaOfInterest', 'ArFeatures', 'GazeFeatures', 'GazeAnalysis', 'PupilFeatures', 'PupilAnalysis', 'DataFeatures', 'utils'] def load(filepath: str) -> any: - """ - Load object instance from .json file. + """ + Load object from json file. - !!! note - The directory where configuration file is will be the global working directory. + !!! note + The directory where json file is will be used as global working directory. - Parameters: - filepath: path to json configuration file - """ + Parameters: + filepath: path to json file + """ - from argaze import DataFeatures + from argaze import DataFeatures - return DataFeatures.from_json(filepath)
\ No newline at end of file + return DataFeatures.from_json(filepath) +
\ No newline at end of file |