Skip to content

Commit df2cb1e

Browse files
committed
document "add_auxiliary_files" with a section #301
Docs changed.
1 parent 5769c39 commit df2cb1e

File tree

2 files changed

+7
-2
lines changed

2 files changed

+7
-2
lines changed

doc/api.rst

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -310,6 +310,11 @@ Value Description
310310
`False` Maintain the :class:`~ocgis.RequestDataset`'s longitudinal domain.
311311
================= ====================================================================================================
312312

313+
add_auxiliary_files
314+
~~~~~~~~~~~~~~~~~~~
315+
316+
If ``True``, create a new directory and add metadata and other informational files in addition to the converted file. If ``False``, write the target file only to :attr:`dir_output` and do not create a new directory.
317+
313318
allow_empty
314319
~~~~~~~~~~~
315320

src/ocgis/api/operations.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -89,8 +89,8 @@ class OcgOperations(object):
8989
:param interpolate_spatial_bounds: If True and no bounds are available, attempt
9090
to interpolate bounds from centroids.
9191
:type interpolate_spatial_bounds: bool
92-
:param bool add_auxiliary_files: If True, create a new directory and add metadata
93-
and other informational files in addition to the converted file. If False, write
92+
:param bool add_auxiliary_files: If ``True``, create a new directory and add metadata
93+
and other informational files in addition to the converted file. If ``False``, write
9494
the target file only to :attr:`dir_output` and do not create a new directory.
9595
:param function callback: A function taking two parameters: ``percent_complete``
9696
and ``message``.

0 commit comments

Comments
 (0)