docs: update docstring

anna-charlotte · anna-charlotte · commit fbb652e6bdb0 · 2023-02-15T14:25:58.000+01:00
Signed-off-by: anna-charlotte &lt;charlotte.gerhaher@jina.ai&gt;
diff --git a/docarray/typing/url/url_3d/mesh_url.py b/docarray/typing/url/url_3d/mesh_url.py
@@ -45,6 +45,7 @@ class MyDoc(BaseDocument):
             assert isinstance(tensors.vertices, NdArray)
             assert isinstance(tensors.faces, NdArray)
 
+
         :return: VerticesAndFaces object containing vertices and faces information.
         """
         from docarray.documents.mesh.vertices_and_faces import VerticesAndFaces
@@ -59,6 +60,7 @@ class MyDoc(BaseDocument):
     def display(self) -> None:
         """
         Plot mesh from url.
+        This loads the Trimesh instance of the 3D mesh, and then displays it.
         """
         from IPython.display import display
 
diff --git a/docarray/typing/url/url_3d/point_cloud_url.py b/docarray/typing/url/url_3d/point_cloud_url.py
@@ -38,7 +38,7 @@ def load(
 
 
             class MyDoc(BaseDocument):
-                point_cloud_url: PointCloud3DvUrl
+                point_cloud_url: PointCloud3DUrl
 
 
             doc = MyDoc(point_cloud_url="toydata/tetrahedron.obj")
@@ -74,6 +74,24 @@ class MyDoc(BaseDocument):
     def display(self, samples: int = 10000) -> None:
         """
         Plot point cloud from url.
+        First, it loads the point cloud into a :class:`PointsAndColors` object, and then
+        calls display on it. The following is therefore equivalent:
+
+        .. code-block:: python
+
+            import numpy as np
+            from docarray import BaseDocument
+
+            from docarray.documents import PointCloud3D
+
+            pc = PointCloud3D("toydata/tetrahedron.obj")
+
+            # option 1
+            pc.url.display()
+
+            # option 2 (equivalent)
+            pc.url.load().display()
+
         :param samples: number of points to sample from the mesh.
         """
         self.load(samples=samples).display()
