small documentation error

[notestaff]

At

seqan3/include/seqan3/contrib/stream/bgzf.hpp

Line 17 in ffabe95

/*!\brief A static variable indicating the number of threads to use for the bgzf-streams. Defaults to 4.

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]

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]

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.