From 7e2ee0e2571120be4d0950b2c89eebf4ede9eb1e Mon Sep 17 00:00:00 2001 From: Enrico Seiler Date: Thu, 29 Feb 2024 14:58:23 +0100 Subject: [PATCH] [DOC] unknown tags will not throw --- include/seqan3/io/sam_file/detail/format_sam_base.hpp | 8 +++++--- 1 file changed, 5 insertions(+), 3 deletions(-) diff --git a/include/seqan3/io/sam_file/detail/format_sam_base.hpp b/include/seqan3/io/sam_file/detail/format_sam_base.hpp index bd34a029f7..11ac5d42da 100644 --- a/include/seqan3/io/sam_file/detail/format_sam_base.hpp +++ b/include/seqan3/io/sam_file/detail/format_sam_base.hpp @@ -269,9 +269,11 @@ inline void format_sam_base::read_arithmetic_field(std::string_view const & str, * Reading the header format is done according to the official * [SAM format specifications](https://samtools.github.io/hts-specs/SAMv1.pdf). * - * The function throws a seqan3::format_error if any unknown tag was encountered. It will also fail if the format is - * not in a correct state (e.g. required fields are not given), but throwing might occur downstream of the actual - * error. + * The function throws a seqan3::format_error if the format is not in a correct state (e.g. required fields are not + * given), but throwing might occur downstream of the actual error. + * + * If any unknown tag was encountered, a warning will be emitted to std::cerr. This can be configured with + * seqan3::sam_file_input_options::stream_warnings_to. */ template inline void format_sam_base::read_header(stream_view_type && stream_view,