Improve docs

Author: hovnatan

docs/source/superannotate.sdk.rst

@@ -307,6 +307,7 @@ ________________________
 .. autofunction:: superannotate.add_annotation_template_to_json
 .. autofunction:: superannotate.add_annotation_cuboid_to_json
 .. autofunction:: superannotate.add_annotation_comment_to_json
+.. _ref_aggregate_annotations_as_df:
 .. autofunction:: superannotate.aggregate_annotations_as_df
 .. autofunction:: superannotate.df_to_annotations
 .. _ref_filter_annotation_instances:

docs/source/tutorial.sdk.rst

@@ -419,8 +419,8 @@ SuperAnnotate format annotations:
 
    df = sa.aggregate_annotations_as_df("<path_to_project_folder>")
 
-The created DataFrame will have columns :code:`imageName`, :code:`instanceId`,
-:code:`className`, :code:`attributeGroupName`, :code:`attributeName`, :code:`type`, :code:`error`, :code:`locked`, :code:`visible`, :code:`trackingId`, :code:`probability`, :code:`pointLabels`, :code:`meta` (geometry information as string), :code:`commentResolved`, :code:`classColor`, :code:`groupId`.
+The created DataFrame will have columns specified at
+:ref:`aggregate_annotations_as_df <ref_aggregate_annotations_as_df>`.
 
 Example of created DataFrame:
 

superannotate/analytics/common.py

@@ -150,7 +150,7 @@ def aggregate_annotations_as_df(
     :param include_comments: enables inclusion of comments info as commentResolved column
     :type include_comments: bool
 
-    :return: DataFrame on annotations with columns: "imageName", "instanceId" className", "attributeGroupName", "attributeName", "type", "error", "locked", "visible", "trackingId", "probability", "pointLabels", "meta" (geometry information as string), "commentResolved", "classColor", "groupId"
+    :return: DataFrame on annotations with columns: "imageName", "instanceId" className", "attributeGroupName", "attributeName", "type", "error", "locked", "visible", "trackingId", "probability", "pointLabels", "meta" (geometry information as string), "commentResolved", "classColor", "groupId", "imageWidth", "imageHeight", "imageStatus", "imagePinned", "createdAt", "creatorRole", "creationType", "creatorEmail", "updatedAt", "updatorRole", "updatorEmail"
     :rtype: pandas DataFrame
     """
 

superannotate/version.py

@@ -1 +1 @@
-__version__ = "2.4.1"
+__version__ = "2.4.2"