From e7dee1dd1d2bb5106287479dcc459df56cd7e17d Mon Sep 17 00:00:00 2001 From: Michael Macias Date: Fri, 2 Aug 2024 11:26:00 -0500 Subject: [PATCH] fastq: Update format description --- noodles-fastq/src/lib.rs | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) diff --git a/noodles-fastq/src/lib.rs b/noodles-fastq/src/lib.rs index 33507511d..81aae4f37 100644 --- a/noodles-fastq/src/lib.rs +++ b/noodles-fastq/src/lib.rs @@ -7,16 +7,16 @@ //! a sequence, a plus line, and quality scores. //! //! The read name is prefixed with an `@` (at sign) character and includes an optional description, -//! delimited by a space. The sequence is a list of bases encoded using IUPAC base symbols. The -//! plus line is effectively a separator, sometimes repeating the read name and optional -//! description, and is commonly discarded. The quality scores is list of Phred quality scores -//! offset by 33 and is parallel to each base in the sequence. That is, each record can be -//! described like the following: +//! delimited by a space (` `) or horizontal tab (`\t`). The sequence is a list of bases encoded +//! using IUPAC base symbols. The plus line is effectively a separator, sometimes repeating the +//! read name and optional description, and is commonly discarded. The quality scores is list of +//! Phred quality scores (commonly but not guaranteed to be offset by 33) and is parallel to each +//! base in the sequence. That is, each record can be described like the following: //! //! ```text -//! @[ description] +//! @[< |\t>description] //! -//! +[[ description]] +//! +[[< |\t>description]] //! //! ``` //!