The documentation page for function_output_iterator doesn't answer TQN0

Open
#70 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
2/5
Estimated time
1-3 hours
Newbie friendliness
58/100
Issue type
Documentation
Clarity
Clearly specified
Activity status
Stale
Tech stack
cpp
Domain
documentation

Research direction

Open the linked function_output_iterator documentation page and inspect the corresponding documentation source. Check the surrounding page structure for where usage requirements belong; done means the page explicitly answers which header file must be included.

Written by the indexing model from the issue text.

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

Dominant language
C++
Stars
23
Forks
70
PR merge metrics
No merged PRs in 30d

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from boostorg/iterator

All issues in boostorg/iterator

Similar issues

More C++ issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.