Doc: Add Python API docs for Group.CreateMDArray

Author: geographika

gcore/gdalmultidim.cpp

@@ -722,7 +722,7 @@ std::shared_ptr<GDALDimension> GDALGroup::CreateDimension(
  * @param papszOptions Driver specific options determining how the array
  * should be created.
  *
- * @return the new array, or nullptr if case of error
+ * @return the new array, or nullptr in case of error
  */
 std::shared_ptr<GDALMDArray> GDALGroup::CreateMDArray(
     CPL_UNUSED const std::string &osName,

swig/include/python/docs/gdal_mdm_docs.i

@@ -0,0 +1,38 @@
+%feature("docstring")  CreateMDArray "
+
+Create a multidimensional array within a group.
+
+It is recommended that the GDALDimension objects passed in ``dimensions``
+belong to this group, either by retrieving them with :py:meth:`GetDimensions`
+or creating a new one with :py:meth:`CreateDimension`.
+
+See :cpp:func:`GDALGroup::CreateMDArray`.
+
+Parameters
+----------
+name : str
+    name
+dimensions : list
+    List of dimensions, ordered from the slowest varying
+    dimension first to the fastest varying dimension last.
+    Might be empty for a scalar array (if supported by driver)
+data_type: :py:class:`osgeo.gdal.ExtendedDataType`
+options: dict/list
+    an optional dict or list of driver specific ``NAME=VALUE`` option strings.
+
+Returns
+-------
+
+MDArray:
+    the new :py:class:`osgeo.gdal.MDArray` or ``None`` on failure.
+
+Examples
+--------
+>>> drv = gdal.GetDriverByName('MEM')
+>>> mem_ds = drv.CreateMultiDimensional('myds')
+>>> rg = mem_ds.GetRootGroup()
+>>> dimX = rg.CreateDimension('X', None, None, 3)
+>>> ar = rg.CreateMDArray('ar', [dimX], gdal.ExtendedDataType.Create(gdal.GDT_Byte))
+
+";
+

swig/include/python/gdal_python.i

@@ -10,6 +10,7 @@
 %include "gdal_band_docs.i"
 %include "gdal_dataset_docs.i"
 %include "gdal_driver_docs.i"
+%include "gdal_mdm_docs.i"
 %include "gdal_operations_docs.i"
 
 %init %{

swig/python/CMakeLists.txt

@@ -26,6 +26,7 @@ set(GDAL_PYTHON_CSOURCES
        ${PROJECT_SOURCE_DIR}/swig/include/python/docs/gdal_band_docs.i
        ${PROJECT_SOURCE_DIR}/swig/include/python/docs/gdal_dataset_docs.i
        ${PROJECT_SOURCE_DIR}/swig/include/python/docs/gdal_driver_docs.i
+       ${PROJECT_SOURCE_DIR}/swig/include/python/docs/gdal_mdm_docs.i
        ${PROJECT_SOURCE_DIR}/swig/include/python/docs/gdal_operations_docs.i
        ${PROJECT_SOURCE_DIR}/swig/include/python/docs/ogr_docs.i
        ${PROJECT_SOURCE_DIR}/swig/include/python/docs/ogr_featuredef_docs.i