Update docstrings

Author: stfnkth

notebooks/modify-interaction.ipynb

@@ -165,7 +165,7 @@
   },
   {
    "cell_type": "code",
-   "execution_count": 12,
+   "execution_count": 4,
    "id": "7ad0cc6a-c508-44b6-83d1-8f03eb6a7e72",
    "metadata": {},
    "outputs": [],
@@ -178,22 +178,22 @@
   },
   {
    "cell_type": "code",
-   "execution_count": 13,
+   "execution_count": 5,
    "id": "4241d0b7-ab89-4cbd-a60b-988b6896bbd7",
    "metadata": {},
    "outputs": [
     {
      "data": {
       "application/vnd.jupyter.widget-view+json": {
-       "model_id": "1b812264d47748e59f07b996e9c18a8f",
+       "model_id": "76dd6da729614de0864befd370d3034e",
        "version_major": 2,
        "version_minor": 1
       },
       "text/plain": [
        "MapWidget(calls=[{'method': 'addLayer', 'args': ({'id': 'geopandas', 'source': {'@@geojson': {'type': 'Feature…"
       ]
      },
-     "execution_count": 13,
+     "execution_count": 5,
      "metadata": {},
      "output_type": "execute_result"
     }
@@ -204,18 +204,28 @@
   },
   {
    "cell_type": "code",
-   "execution_count": 15,
+   "execution_count": 7,
    "id": "8ca96e77-dbad-4958-8bac-4b92cbd1acbb",
    "metadata": {},
    "outputs": [
     {
      "data": {
       "text/plain": [
-       "{'draw': ['{\"type\":\"Feature\",\"geometry\":{\"type\":\"Point\",\"coordinates\":[-89.9069020159181,-3.410484493977961]},\"properties\":null}',\n",
-       "  '{\"type\":\"Feature\",\"geometry\":{\"type\":\"Point\",\"coordinates\":[-32.14370731485719,-25.10699448813274]},\"properties\":null}']}"
+       "{'draw': [{'type': 'Feature',\n",
+       "   'geometry': {'type': 'Point',\n",
+       "    'coordinates': [-120.47218141829924, -14.347436260705265]},\n",
+       "   'properties': None},\n",
+       "  {'type': 'Feature',\n",
+       "   'geometry': {'type': 'Point',\n",
+       "    'coordinates': [-115.55066021198198, -32.32384479303445]},\n",
+       "   'properties': None},\n",
+       "  {'type': 'Feature',\n",
+       "   'geometry': {'type': 'Point',\n",
+       "    'coordinates': [-91.20204716358482, -21.2491496568545]},\n",
+       "   'properties': None}]}"
       ]
      },
-     "execution_count": 15,
+     "execution_count": 7,
      "metadata": {},
      "output_type": "execute_result"
     }
@@ -226,22 +236,10 @@
   },
   {
    "cell_type": "code",
-   "execution_count": 18,
+   "execution_count": null,
    "id": "e80b179d-9ce6-410c-b28b-9d232e478685",
    "metadata": {},
-   "outputs": [
-    {
-     "ename": "TypeError",
-     "evalue": "string indices must be integers, not 'str'",
-     "output_type": "error",
-     "traceback": [
-      "\u001b[31m---------------------------------------------------------------------------\u001b[39m",
-      "\u001b[31mTypeError\u001b[39m                                 Traceback (most recent call last)",
-      "\u001b[36mCell\u001b[39m\u001b[36m \u001b[39m\u001b[32mIn[18]\u001b[39m\u001b[32m, line 1\u001b[39m\n\u001b[32m----> \u001b[39m\u001b[32m1\u001b[39m \u001b[43mm\u001b[49m\u001b[43m.\u001b[49m\u001b[43mfeatures\u001b[49m\u001b[43m[\u001b[49m\u001b[33;43m\"\u001b[39;49m\u001b[33;43mdraw\u001b[39;49m\u001b[33;43m\"\u001b[39;49m\u001b[43m]\u001b[49m\u001b[43m[\u001b[49m\u001b[32;43m0\u001b[39;49m\u001b[43m]\u001b[49m\u001b[43m[\u001b[49m\u001b[33;43m\"\u001b[39;49m\u001b[33;43mtype\u001b[39;49m\u001b[33;43m\"\u001b[39;49m\u001b[43m]\u001b[49m\n",
-      "\u001b[31mTypeError\u001b[39m: string indices must be integers, not 'str'"
-     ]
-    }
-   ],
+   "outputs": [],
    "source": [
     "m.features[\"draw\"][0][\"type\"]"
    ]

src/openlayers/map.py

@@ -72,20 +72,21 @@ def set_view_from_source(self, layer_id: str) -> None:
         self.add_call("setViewFromSource", layer_id)
 
     def set_zoom(self, zoom_level: float | int) -> None:
-        """Set the zoom level ot the map view
+        """Set the zoom level of the view
 
         Args:
-            zoom_level (float | int): The zoom level of the view
+            zoom_level (float | int): The zoom level
         """
         self.add_view_call("setZoom", zoom_level)
 
-    def set_center(self, lonlat: tuple[float, float]) -> None:
-        """Set the center of the map view
+    def set_center(self, lon: float = 0, lat: float = 0) -> None:
+        """Set the center of the view
 
         Args:
-            lonlat (tuple[float, float]): The centerpoint of the map as `(lon, lat)` pair
+            lon (float): The center's longitude
+            lat (float): The center's latitude
         """
-        self.add_view_call("setCenter", lonlat)
+        self.add_view_call("setCenter", (lon, lat))
 
     def add_layer(self, layer: LayerT | LayerLike | dict) -> None:
         """Add a layer to the map

src/openlayers/models/view.py

@@ -2,7 +2,6 @@
 
 from pydantic import Field
 
-# from ..abstracts import MyBaseModel
 from .core import OLBaseModel
 
 
@@ -17,19 +16,20 @@ def from_epsg(code: int) -> str:
 
 
 class View(OLBaseModel):
-    """View object
+    """A View object represents a simple 2D view of the map
 
     Note:
         See [module-ol_View-View.html](https://openlayers.org/en/latest/apidoc/module-ol_View-View.html) for details.
 
     Attributes:
-        center (tuple[float, float]): The centerpoint of the map as `(lon, lat)` pair
-        zoom (float | int): The zoom level of the map
-        projection (str): ...
-        rotation (float | int): ...
-        extent (tuple[float, float, float, float] | list[float, float, float, float]): ...
-        min_zoom (float | int): The minimum zoom level of the map
-        max_zoom (float | int): The maximum zoom level of the map
+        center (tuple[float, float]): The center for the view as (lon, lat) pair
+        zoom (float | int): The Zoom level used to calculate the resolution for the view
+        projection (str): The projection
+        rotation (float | int): The rotation for the view in radians (positive rotation clockwise, 0 means north).
+        extent (tuple[float, float, float, float] | list[float, float, float, float]): The extent that constrains the view,
+            in other words, nothing outside of this extent can be visible on the map
+        min_zoom (float | int): The minimum zoom level used to determine the resolution constraint
+        max_zoom (float | int): The maximum zoom level used to determine the resolution constraint
     """
 
     center: tuple[float, float] | None = (0, 0)