Merge pull request #55 from ImperialCollegeLondon/export_geojson_docs…

…tring added export_geojson docstring
ImperialCollegeLondon · Jul 29, 2022 · d0e7a2c · d0e7a2c
2 parents c52cb31 + 99fb52c
commit d0e7a2c
Showing 1 changed file with 7 additions and 0 deletions.
diff --git a/virtual_rainforest/core/grid.py b/virtual_rainforest/core/grid.py
@@ -155,6 +155,13 @@ def _make_hex_grid(cell_area: float, cell_nx: int, cell_ny: int) -> dict:
         return cell_dict
 
     def export_geojson(self, outfile: str):
+        """Export grid system as geojson file.
+
+
+        Args:
+            outfile: A self.cell_dict returned by a make_square_grid
+                     or make_hex_grid call.
+        """
 
         # Open a collection for writing.
         with fiona.open(