llvm/llvm-project

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

Open

#166,155 opened on 2025年11月3日

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

説明

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.

コントリビューターガイド

技術スタック
cpp
領域
documentation
Issue 種別
documentation
難度新しい貢献者にとっての実装難度です。1 は非常に小さな変更、5 は専門的な作業です。
3
推定時間経験ある貢献者が調査、実装、テスト、pull request 準備にかけるおおよその時間範囲です。
half day
活動状況Issue が今どれだけ取り組みやすいかを示します。新しい、活発、古い、ブロック中、またはメンテナー入力待ちなどです。
blocked
明確さ期待される変更、受け入れ条件、次の手順がどれだけ明確かを示します。
clear
前提条件
C++ basicsLLVM coding styleunderstanding of DenseMap
初心者向け度初回貢献者にどれだけ取り組みやすいかを 1-100 で推定したスコアです。
45
調査方針
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.