more comments

Signed-off-by: Yee Hing Tong <[email protected]>

flytekit/models/admin/common.py

@@ -471,10 +471,12 @@ def from_flyte_idl(cls, p):
 class AuthRole(FlyteIdlEntity):
     def __init__(self, assumable_iam_role=None, kubernetes_service_account=None):
         """
-        At most one of assumable_iam_role or kubernetes_service_account can be set.
+        Either one or both of the assumable IAM role and/or the K8s service account can be set.
+
         :param Text assumable_iam_role: IAM identity with set permissions policies.
-        :param Text kubernetes_service_account: Provides an identity for workflow execution resources. Flyte deployment
-            administrators are responsible for handling permissions as they relate to the service account.
+        :param Text kubernetes_service_account: Provides an identity for workflow execution resources.
+          Flyte deployment administrators are responsible for handling permissions as they
+          relate to the service account.
         """
         self._assumable_iam_role = assumable_iam_role
         self._kubernetes_service_account = kubernetes_service_account

flytekit/models/core/execution.py

@@ -4,6 +4,11 @@
 
 
 class WorkflowExecutionPhase(object):
+    """
+    This class holds enum values used for setting notifications. See :py:class:`flytekit.Email`
+    for sample usage.
+    """
+
     UNDEFINED = _execution_pb2.WorkflowExecution.UNDEFINED
     QUEUED = _execution_pb2.WorkflowExecution.QUEUED
     RUNNING = _execution_pb2.WorkflowExecution.RUNNING

flytekit/models/core/literals.py

@@ -237,6 +237,9 @@ def from_flyte_idl(cls, proto):
 class Blob(_common.FlyteIdlEntity):
     def __init__(self, metadata, uri):
         """
+        This literal model is used to represent binary data offloaded to some storage location which is
+        identifiable with a unique string. See :py:class:`flytekit.FlyteFile` as an example.
+
         :param BlobMetadata metadata:
         :param Text uri: The location of this blob
         """

flytekit/models/core/types.py

@@ -177,6 +177,7 @@ def __init__(
     ):
         """
         Only one of the kwargs may be set.
+
         :param int simple: Enum type from SimpleType
         :param flytekit.models.core.types.SchemaType schema: Type definition for a dataframe-like object.
         :param LiteralType collection_type: For list-like objects, this is the type of each entry in the list.