microsoft / microsoft/STL

`<xmemory>`: Document the iterator debugging invariants

Open
#2,084 2 comments 0 reactions 1 assignee View on GitHub

@StephanTLavavej is already working on this.

Since Jul 29, 2021.

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

Description

Currently, the iterator debugging scheme involving a proxy object and an intrusive singly-linked list of iterators isn't well-commented in the codebase. The maintainers should capture their knowledge in a detailed comment next to the machinery:

https://github.com/microsoft/STL/blob/bd7adb4a932725f60ba096580c415616486ab64c/stl/inc/xmemory#L1053-L1059

Thanks to @mnatsuhara for the suggestion! Uncommented invariants make it difficult to understand/maintain code.

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.

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.