Added documentation

This commit is contained in:
Stijn Van Campenhout
2019-09-18 12:11:42 +02:00
parent 1108f87ec9
commit 2222856f4d
6 changed files with 167 additions and 42 deletions

View File

@@ -4,8 +4,7 @@ from yaml import dump as yml_dump
def load() -> dict:
"""
Load the .rmapi config file
"""Load the .rmapi config file
"""
config_file_path = Path.joinpath(Path.home(), ".rmapi")
@@ -18,8 +17,11 @@ def load() -> dict:
def dump(config: dict) -> True:
"""
Dump config to the .rmapi config file
"""Dump config to the .rmapi config file
Args:
config: A dict containing data to dump to the .rmapi
config file.
"""
config_file_path = Path.joinpath(Path.home(), ".rmapi")