Skip to content

Commit 04ede5a

Browse files
committed
chg: update Documentation for save_to_file() !minor
1 parent 2abf9c4 commit 04ede5a

File tree

1 file changed

+9
-1
lines changed

1 file changed

+9
-1
lines changed

docs/source/quickstart.rst

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -372,8 +372,16 @@ The current state of any :class:`~nmrpy.data_objects.FidArray` object can be
372372
saved to file using the :meth:`~nmrpy.data_objects.FidArray.save_to_file` method: ::
373373

374374
>>> fid_array.save_to_file(filename='fidarray.nmrpy')
375+
376+
The filename need not be specified, if not given the name is taken from
377+
:attr:`~nmrpy.data_objects.FidArray.fid_path` and the `.nmrpy` extension is
378+
appended. If the file exists, it is not overwritten; a forced overwrite can
379+
be specified with: ::
380+
381+
>>> fid_array.save_to_file(filename='fidarray.nmrpy', overwrite=True)
375382

376-
And reloaded using :meth:`~nmrpy.data_objects.FidArray.from_path`: ::
383+
The :class:`~nmrpy.data_objects.FidArray` can be reloaded using
384+
:meth:`~nmrpy.data_objects.FidArray.from_path`: ::
377385

378386
>>> fid_array = nmrpy.from_path(fid_path='fidarray.nmrpy')
379387

0 commit comments

Comments
 (0)