From cbffe5dd98643cbc770ebd615833458137e330aa Mon Sep 17 00:00:00 2001 From: Lydia Buntrock Date: Mon, 19 Apr 2021 12:01:57 +0200 Subject: [PATCH] [DOC] Add changelog entry Signed-off-by: Lydia Buntrock --- CHANGELOG.md | 10 ++++++---- 1 file changed, 6 insertions(+), 4 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index a106c974ca..13331ebd4a 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -32,6 +32,8 @@ If possible, provide tooling that performs the changes, e.g. a shell-script. * Added `seqan3::phred94`, a quality type that represents the full Phred Score range (Sanger format) and is used for PacBio Phred scores of HiFi reads ([\#2290](https://github.com/seqan/seqan3/pull/2290)). +* Deprecated `seqan3::sam_dna16`. Use `seqan3::dna16sam` instead. + ([\#2521](https://github.com/seqan/seqan3/pull/2521)). #### Argument Parser @@ -59,8 +61,8 @@ If possible, provide tooling that performs the changes, e.g. a shell-script. to add convenient functions that compute information based on the record itself and to provide better documentation. ([\#2340](https://github.com/seqan/seqan3/pull/2340), [\#2380](https://github.com/seqan/seqan3/pull/2380), [\#2389](https://github.com/seqan/seqan3/pull/2389)) -* Deprecated `seqan3::field::seq_qual`. Use `seqan3::fiel::seq` and `seqan3::field::qual` instead. - ([\#2379](https://github.com/seqan/seqan3/pull/2379)). Check out +* Deprecated `seqan3::field::seq_qual`. Use `seqan3::field::seq` and `seqan3::field::qual` instead. + ([\#2379](https://github.com/seqan/seqan3/pull/2379)). Check out [SeqAn3 Cookbook - Write Record](https://docs.seqan.de/seqan/3.0.3/cookbook.html) for usage. @@ -112,8 +114,8 @@ If possible, provide tooling that performs the changes, e.g. a shell-script. ## API changes -Most of our API or header file changes will trigger a deprecation warning to let you know if something changed and, if -applicable, when it will be removed. We recommend upgrading version-by-version to check whether you need to change code. +Most of our API or header file changes will trigger a deprecation warning to let you know if something changed and, if +applicable, when it will be removed. We recommend upgrading version-by-version to check whether you need to change code. You can either directly check the reported code or verify with our documentation how the new API should be used. For a complete list of behavioural changes in our public and internal API, you can consult our API stability