Review feedback

Author: Ubuntu

nucleus/dataset_item.py

@@ -122,11 +122,13 @@ class DatasetItem:  # pylint: disable=R0902
 
 
     Attributes:
-        image_location: (required if pointcloud_location not present) The location
+        image_location: Required if pointcloud_location not present: The location
             containing the image for the given row of data. This can be a local path, or a remote URL.
             Remote formats supported include any URL (http:// or https://) or URIs for AWS S3, Azure, or GCS,
             (i.e. s3://, gcs://)
-        reference_id: (required) A user-specified identifier to reference the item.
+        reference_id: (required) A user-specified identifier to reference the item. The
+          default value is present in order to not have to change argument order, but
+          must be replaced.
         metadata: Extra information about the particular dataset item. ints, floats,
           string values will be made searchable in the query bar by the key in this dict
           For example, {"animal": "dog"} will become searchable via
@@ -156,24 +158,24 @@ class DatasetItem:  # pylint: disable=R0902
           so your second ingestion will be faster than your first.
           TODOC(Shorten this once we have a guide migrated for metadata, or maybe link
           from other places to here.)
-        pointcloud_location: (required if image_location not passed) The remote URL
+        pointcloud_location: Required if image_location not present: The remote URL
           containing the pointcloud JSON. Remote formats supported include any URL
           (http:// or https://) or URIs for AWS S3, Azure, or GCS, (i.e. s3://, gcs://)
-        upload_to_scale: Set this to false in order to use `privacy mode<https://dashboard.scale.com/nucleus/docs/api#privacy-mode>`_. TODOC (update this once guide is migrated).
-          Briefly speaking, setting this to flase means the actual data within the item
+        upload_to_scale: Set this to false in order to use `privacy mode <https://dashboard.scale.com/nucleus/docs/api#privacy-mode>`_. TODOC (update this once guide is migrated).
+          Setting this to false means the actual data within the item
           (i.e. the image or pointcloud) will not be uploaded to scale meaning that
           you can send in links that are only accessible to certain users, and not to
           Scale.
     """
 
     image_location: Optional[str] = None
-    reference_id: Optional[str] = None
+    reference_id: str = "DUMMY_VALUE"  # Done in order to preserve argument ordering and not break old clients.
     metadata: Optional[dict] = None
     pointcloud_location: Optional[str] = None
     upload_to_scale: Optional[bool] = True
 
     def __post_init__(self):
-        assert self.reference_id is not None, "reference_id is required."
+        assert self.reference_id != "DUMMY_VALUE", "reference_id is required."
         assert bool(self.image_location) != bool(
             self.pointcloud_location
         ), "Must specify exactly one of the image_location, pointcloud_location parameters"