microsoft / microsoft/STL

`<xutility>`: What's the intent of the pseudo-documentation?

Open
#5,081 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

enhancement
Dominant language
C++
Stars
11.2k
Forks
1.7k
Avg merge
4d 15h
Merged PRs (30d)
22

Description

The class template _Is_checked_helper has been left unused since the initial commit on Github.

https://github.com/microsoft/STL/blob/25dc2b72b6f594326253cf3a05543f7a5750f802/stl/inc/xutility#L1305-L1306

It's unclear what the "pseudo-documentation" is. Perhaps we should either improve the comment or entirely remove _Is_checked_helper.

Contributor guide

Open the contributing guide

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.

Research direction

Start in stl/inc/xutility at lines 1305-1306 and inspect the unused _Is_checked_helper declaration and its surrounding comment. Determine whether the comment can clearly document the intent or whether the helper should be removed; done means the ambiguity is resolved in the source without leaving the unused pseudo-documentation.

Written by the indexing model from the issue text.

Assessment

Tech stack
cpp
Domain
tooling
Issue type
Refactor
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.