From 93881178cc9710b51b060b4a40f630834f089741 Mon Sep 17 00:00:00 2001
From: Ashley Barnes <53282288+ashjbarnes@users.noreply.github.com>
Date: Wed, 15 Nov 2023 19:22:37 +1100
Subject: [PATCH] Update `_make_hgrid` docstring (#82)

* Update docstring as pointed out in issue 52

* black reformat

* navid comment
---
 regional_mom6/regional_mom6.py | 10 +++-------
 1 file changed, 3 insertions(+), 7 deletions(-)

diff --git a/regional_mom6/regional_mom6.py b/regional_mom6/regional_mom6.py
index fd2e6b14..a2c2913a 100644
--- a/regional_mom6/regional_mom6.py
+++ b/regional_mom6/regional_mom6.py
@@ -510,14 +510,10 @@ def __init__(
     def _make_hgrid(self, gridtype):
         """Sets up hgrid based on users specification of
         domain. Default behaviour leaves latitude and longitude evenly
-        spaced.
-
-        If user specifies a resolution of 0.1 degrees, longitude is
-        spaced this way and latitude spaced with 0.1
-        cos(mean_latitude). This way, grids in the centre of the
-        domain are perfectly square, but decrease monatonically in
-        area away from the equator
+        spaced. This is very simple but suitable for small domains.
 
+        Note:
+            The intention is for the hgrid generation to be very flexible. For now there is only one implemented horizontal grid included in the package, but you can customise it by simply overwriting the `hgrid.nc` file that's deposited in your `rundir` after initialising an `experiment`. To conserve the metadata, it might be easiest to read the file in, then modify the fields before re-saving.
         """
 
         if gridtype == "even_spacing":