seqan3::exposition_only Namespace Reference

A namespace for SeqAn entities that are intended for documentation purposes only. More...

Classes
class	cigar_operation
	The actual implementation of seqan3::cigar::operation for documentation purposes only. More...

Detailed Description

A namespace for SeqAn entities that are intended for documentation purposes only.

We try to guarantee a strong API-Stability. This has the downside that we sometimes opt to not document entities, because

1. we do not want to guarantee that the entity will always keep the same name or
2. we need a helper entity to define the actual entity or
3. we are not completely sure if the entity is general enough to mark it stable,

but we still want to express a general look-and-feel of the API in our documentation.

We therefore use the same trick as the C++ standard that defines entities, s.a. concepts, in a partial defined state to express a general intend of the API without being explicit about it.

For example, see https://eel.is/c++draft/iterator.concept.readable where indirectly-readable-impl describes the general intention of the concept, but does not name it since it is a helper-entity for the std::indirectly_readable concept.