search

seqan / seqan3

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

small documentation error #3237

Closed notestaff closed 4 months ago

notestaff commented 4 months ago

At https://github.com/seqan/seqan3/blob/ffabe95327e99f954db0cf116ce189b36284c49d/include/seqan3/contrib/stream/bgzf.hpp#L17 the variable is no longer static.

Also, maybe doc/cookbook/compression_threads.cpp should include this file, rather than seqan3/io/all.hpp? Or this file is not part of the public API?

SGSSGene commented 4 months ago

Thank you! This is a mistake in the documentation. PR #3238 will fix this. bgzf_thread_count is meant to be used to change number of threads being used.

About the include path, I am not so sure, I will discuss this with the others.

eseiler commented 4 months ago

The contrib include is completely non-API.

But you don't need io/all.hpp either. If you only use a specific io, it is enough to include that.

Any IO that supports compression will implicitly include this bgzf header.