boostorg / boostorg/iterator

The documentation page for function_output_iterator doesn't answer TQN0

Open
#70 0 comments 0 reactions 0 assignees View on GitHub
Dominant language
C++
Stars
23
Forks
70
PR merge metrics
No merged PRs in 30d

Description

Documentation authors can safely assume that whenever somebody visits a documentation page to see documentation about a particular class, template, function, or any other kind of Thing That Can Be Used In Code, that person **will, with absolute certainty**, need to know the answer to The Question Number Zero (TQN0).

The Question Number Zero goes like this:

> Which header file must I include in order to be able to use this thing in my code?

Please, always answer TQN0 on every documentation page that documents anything that needs an include file in other to be used.

https://www.boost.org/doc/libs/1_78_0/libs/iterator/doc/html/iterator/specialized/function_output.html

Contributor guide

No contributing guide indexed for this repository

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.