From ad99d2a841f4cf581f13f2ef1e9f93e95c84760e Mon Sep 17 00:00:00 2001
From: iLLiCiTiT <jakub.trllo@gmail.com>
Date: Thu, 9 Dec 2021 12:21:12 +0100
Subject: [PATCH] added few docstrings

---
 igniter/__init__.py                           |  4 ++++
 igniter/message_dialog.py                     |  2 +-
 .../settings/entities/op_version_entity.py    | 19 ++++++++++++++++++-
 openpype/tools/settings/settings/base.py      |  1 +
 4 files changed, 24 insertions(+), 2 deletions(-)

diff --git a/igniter/__init__.py b/igniter/__init__.py
index 6f06c1eb90..02cba6a483 100644
--- a/igniter/__init__.py
+++ b/igniter/__init__.py
@@ -12,6 +12,9 @@ from .bootstrap_repos import (
 )
 from .version import __version__ as version
 
+# Store OpenPypeVersion to 'sys.modules'
+#   - this makes it available in OpenPype processes without modifying
+#       'sys.path' or 'PYTHONPATH'
 if "OpenPypeVersion" not in sys.modules:
     sys.modules["OpenPypeVersion"] = OpenPypeVersion
 
@@ -64,6 +67,7 @@ def open_update_window(openpype_version):
 
 
 def show_message_dialog(title, message):
+    """Show dialog with a message and title to user."""
     if os.getenv("OPENPYPE_HEADLESS_MODE"):
         print("!!! Can't open dialog in headless mode. Exiting.")
         sys.exit(1)
diff --git a/igniter/message_dialog.py b/igniter/message_dialog.py
index 88a086df1e..c8e875cc37 100644
--- a/igniter/message_dialog.py
+++ b/igniter/message_dialog.py
@@ -7,6 +7,7 @@ from .tools import (
 
 
 class MessageDialog(QtWidgets.QDialog):
+    """Simple message dialog with title, message and OK button."""
     def __init__(self, title, message):
         super(MessageDialog, self).__init__()
 
@@ -27,7 +28,6 @@ class MessageDialog(QtWidgets.QDialog):
         btns_layout.addWidget(ok_btn, 0)
 
         layout = QtWidgets.QVBoxLayout(self)
-        # layout.setContentsMargins(0, 0, 0, 0)
         layout.addWidget(label_widget, 1)
         layout.addLayout(btns_layout, 0)
 
diff --git a/openpype/settings/entities/op_version_entity.py b/openpype/settings/entities/op_version_entity.py
index bd481dc497..62c5bf4ff9 100644
--- a/openpype/settings/entities/op_version_entity.py
+++ b/openpype/settings/entities/op_version_entity.py
@@ -12,6 +12,16 @@ from .exceptions import BaseInvalidValue
 
 
 class OpenPypeVersionInput(TextEntity):
+    """Entity to store OpenPype version to use.
+
+    It is text input as creating of settings on different machines may
+    affect which versions are available so it must have option to set OpenPype
+    version which is not available for machine where settings entities are
+    loaded.
+
+    It is possible to enter empty string. In that case is used any latest
+    version. Any other string must match regex of OpenPype version semantic.
+    """
     def _item_initialization(self):
         super(OpenPypeVersionInput, self)._item_initialization()
         self.multiline = False
@@ -19,9 +29,13 @@ class OpenPypeVersionInput(TextEntity):
         self.value_hints = []
 
     def _get_openpype_versions(self):
-        return []
+        """This is abstract method returning version hints for UI purposes."""
+        raise NotImplementedError((
+            "{} does not have implemented '_get_openpype_versions'"
+        ).format(self.__class__.__name__))
 
     def set_override_state(self, state, *args, **kwargs):
+        """Update value hints for UI purposes."""
         value_hints = []
         if state is OverrideState.STUDIO:
             versions = self._get_openpype_versions()
@@ -36,6 +50,7 @@ class OpenPypeVersionInput(TextEntity):
         )
 
     def convert_to_valid_type(self, value):
+        """Add validation of version regex."""
         if value and value is not NOT_SET:
             OpenPypeVersion = get_OpenPypeVersion()
             if OpenPypeVersion is not None:
@@ -52,6 +67,7 @@ class OpenPypeVersionInput(TextEntity):
 
 
 class ProductionVersionsInputEntity(OpenPypeVersionInput):
+    """Entity meant only for global settings to define production version."""
     schema_types = ["production-versions-text"]
 
     def _get_openpype_versions(self):
@@ -61,6 +77,7 @@ class ProductionVersionsInputEntity(OpenPypeVersionInput):
 
 
 class StagingVersionsInputEntity(OpenPypeVersionInput):
+    """Entity meant only for global settings to define staging version."""
     schema_types = ["staging-versions-text"]
 
     def _get_openpype_versions(self):
diff --git a/openpype/tools/settings/settings/base.py b/openpype/tools/settings/settings/base.py
index bc6c6d10ff..48c2b42ebd 100644
--- a/openpype/tools/settings/settings/base.py
+++ b/openpype/tools/settings/settings/base.py
@@ -28,6 +28,7 @@ class BaseWidget(QtWidgets.QWidget):
 
     @staticmethod
     def set_style_property(obj, property_name, property_value):
+        """Change QWidget property and polish it's style."""
         if obj.property(property_name) == property_value:
             return