From a1a27784ae85f5c7da925059c4ff3f0b4ef66429 Mon Sep 17 00:00:00 2001 From: Ondrej Samohel Date: Tue, 17 Mar 2020 00:01:35 +0100 Subject: [PATCH] updated docs --- pype/unreal/lib.py | 12 +++++++++++- pype/unreal/plugin.py | 2 ++ 2 files changed, 13 insertions(+), 1 deletion(-) diff --git a/pype/unreal/lib.py b/pype/unreal/lib.py index be6314b09b..faf3a6e99f 100644 --- a/pype/unreal/lib.py +++ b/pype/unreal/lib.py @@ -13,7 +13,17 @@ def get_engine_versions(): Location can be overridden by `UNREAL_ENGINE_LOCATION` environment variable. - Returns dictionary with version as a key and dir as value. + Returns: + + dict: dictionary with version as a key and dir as value. + + Example: + + >>> get_engine_version() + { + "4.23": "C:/Epic Games/UE_4.23", + "4.24": "C:/Epic Games/UE_4.24" + } """ try: engine_locations = {} diff --git a/pype/unreal/plugin.py b/pype/unreal/plugin.py index d403417ad1..0c00eb77d6 100644 --- a/pype/unreal/plugin.py +++ b/pype/unreal/plugin.py @@ -2,8 +2,10 @@ from avalon import api class Creator(api.Creator): + """This serves as skeleton for future Pype specific functionality""" pass class Loader(api.Loader): + """This serves as skeleton for future Pype specific functionality""" pass