llvm/llvm-project

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

Open

#166155 opened on Nov 3, 2025

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

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

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.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
half day
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
blocked
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
C++ basicsLLVM coding styleunderstanding of DenseMap
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
45
Research direction
The issue requests documentation for several non trivial DenseMapBase member functions (try emplace, insert or assign, etc.) with code samples. The primary file to modify is likely `llvm/include/llvm/ADT/DenseMap.h`, where these functions are defined. Check the existing documentation style in that file for consistency. The issue has two assignees, so check their progress or any linked branches before starting. The discussion in comments may provide additional guidance.