Skip to content

Commit 4befc28

Browse files
committed
Docstring fixes
1 parent 4638c8f commit 4befc28

1 file changed

Lines changed: 11 additions & 6 deletions

File tree

swig/include/python/docs/gdal_mdm_docs.i

Lines changed: 11 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -2,27 +2,32 @@
22
33
Create a multidimensional array within a group.
44
5+
It is recommended that the GDALDimension objects passed in aoDimensions
6+
belong to this group, either by retrieving them with :py:func:`osgeo.gdal.Group.GetDimensions`
7+
or creating a new one with :py:func:`osgeo.gdal.Group.CreateDimension`.
8+
59
See :cpp:func:`GDALGroup::CreateMDArray`.
610
711
Parameters
812
----------
9-
osName : str
13+
name : str
1014
name
11-
aoDimensions : list
15+
dimensions : list
1216
List of dimensions, ordered from the slowest varying
1317
dimension first to the fastest varying dimension last.
1418
Might be empty for a scalar array (if supported by driver)
15-
oDataType: GDALExtendedDataType
16-
papszOptions : CSLConstList
19+
data_type: :py:class:`osgeo.gdal.ExtendedDataType`
20+
options: dict/list
21+
an optional dict or list of driver specific ``NAME=VALUE`` option strings.
1722
1823
Returns
1924
-------
2025
21-
GDALMDArray - the new array
26+
MDArray:
27+
the new :py:class:`osgeo.gdal.MDArray` or ``None`` on failure.
2228
2329
Examples
2430
--------
25-
>>> from osgeo import gdal
2631
>>> drv = gdal.GetDriverByName('MEM')
2732
>>> mem_ds = drv.CreateMultiDimensional('myds')
2833
>>> rg = mem_ds.GetRootGroup()

0 commit comments

Comments
 (0)