diff options
| author | Thomas White <taw@physics.org> | 2022-03-08 14:55:03 +0100 |
|---|---|---|
| committer | Thomas White <taw@physics.org> | 2022-03-08 17:41:52 +0100 |
| commit | 0b758e3ae3c3fd66c75a42740a80afbabba5c82f (patch) | |
| tree | 8ee6eb7fc436a19930651f35d97061b995e19bf5 /libcrystfel | |
| parent | d86ac7380711ba6a4bf719a78395d16e6bef8cd2 (diff) | |
stream_open_for_write: Fix documentation
Diffstat (limited to 'libcrystfel')
| -rw-r--r-- | libcrystfel/src/stream.c | 5 |
1 files changed, 4 insertions, 1 deletions
diff --git a/libcrystfel/src/stream.c b/libcrystfel/src/stream.c index cbd08272..4836d24b 100644 --- a/libcrystfel/src/stream.c +++ b/libcrystfel/src/stream.c @@ -1158,7 +1158,10 @@ void stream_write_target_cell(Stream *st, UnitCell *cell) * Creates a new stream with name \p filename. If \p filename already * exists, it will be overwritten. * - * Audit information (e.g. CrystFEL version number) will be written. + * The CrystFEL version number will be written, but you should call + * stream_write_geometry_file, stream_write_target_cell, + * stream_write_commandline_args and stream_write_Indexing_methods to write + * extended audit information. * * \returns A \ref Stream, or NULL on failure. */ |