llvm/llvm-project

[llvm] Document non-trivial `llvm::DenseMapBase` member functions

Open

#166,155 opened on Nov 3, 2025

View on GitHub
 (7 comments) (0 reactions) (2 assignees)C++ (10,782 forks)batch import
documentationenhancementgood first issuellvm:adt

Repository metrics

Stars
 (26,378 stars)
PR merge metrics
 (Avg merge 1d 2h) (1,000 merged PRs in 30d)

Description

There are (now?) some non-trivial memberfunctions in DenseMapBase that would be good to document, possibly adding a code sample.

From looking at https://llvm.org/doxygen/classllvm_1_1DenseMap.html, examples include:

  1. try_emplace
  2. insert_or_assign
  3. emplace_or_assign
  4. lookup_or
  5. operator[] - should specify what happens if the key isn't yet in the map.

Contributor guide

Research direction
Review the DenseMapBase member functions listed in the issue on the doxygen page and write clear documentation with code samples for each: try emplace, insert or assign, emplace or assign, lookup or, and operator[].
Tech stack
cpp
Domain
documentation
Issue type
Documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
1
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
C++
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
80