search

seqan / seqan3

The modern C++ library for sequence analysis. Contains version 3 of the library and API docs.
https://www.seqan.de
Other
398 stars 81 forks source link

incorrect documentation of alignment result? #3202

Closed notestaff closed 9 months ago

notestaff commented 9 months ago

Platform

Question

Docs of sequence1_begin_position() say it returns "the begin position of the first sequence", but also that it returns "a pair of positions". Is the "pair" comment incorrect?

/*!\brief Returns the begin position of the first sequence of the alignment.
 * \return  A pair of positions in the respective sequences, where the calculated alignment starts.
 *
 * \details
 *
 * Guaranteed to be smaller than or equal to `sequence1_end_position()`.
 *
 * \note This function is only available if the begin position of the first sequence was requested via the
 * alignment configuration (see seqan3::align_cfg::output_begin_position).
 */
constexpr auto sequence1_begin_position() const noexcept
eseiler commented 9 months ago

Hey @notestaff ,

it is indeed just a size_t, not a pair. Thanks for noticing and notifying!

The error was introduced during some refactoring (#1948). We'll prepare a PR that will close this issue once merged.