From 0b758e3ae3c3fd66c75a42740a80afbabba5c82f Mon Sep 17 00:00:00 2001 From: Thomas White Date: Tue, 8 Mar 2022 14:55:03 +0100 Subject: stream_open_for_write: Fix documentation --- libcrystfel/src/stream.c | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) (limited to 'libcrystfel/src/stream.c') 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. */ -- cgit v1.2.3