From 19673e3b1c0b32d09716fff0b265b3dc829ffe8d Mon Sep 17 00:00:00 2001
From: Christian Mazakas <christian.mazakas@gmail.com>
Date: Thu, 6 Jan 2022 15:29:40 -0800
Subject: [PATCH] Update reference docs for `erase()` to include heterogeneous
 overloads

---
 doc/ref.php | 26 ++++++++++++++++++++++++++
 1 file changed, 26 insertions(+)

diff --git a/doc/ref.php b/doc/ref.php
index 21b824e3..f34ed038 100644
--- a/doc/ref.php
+++ b/doc/ref.php
@@ -1116,6 +1116,32 @@ EOL;
                 <para>Only throws an exception if it is thrown by <code>hasher</code> or <code>key_equal</code>.</para>
               </throws>
             </method>
+            <method name="erase">
+              <template>
+                <template-type-parameter name="K" />
+              </template>
+              <parameter name="k">
+                <paramtype>K&amp;&amp;</paramtype>
+              </parameter>
+              <type>size_type</type>
+              <returns>
+                <para>The number of elements erased.</para>
+              </returns>
+              <throws>
+                <para>Only throws an exception if it is thrown by <code>hasher</code> or <code>key_equal</code>.</para>
+              </throws>
+              <description>
+                <para>Erase all elements with key equivalent to <code>k</code>.</para>
+                <para>
+                  This overload only participates in overload resolution if <code>Hash::is_transparent</code>
+                  and <code>Pred::is_transparent</code> are valid member typedefs and neither <code>iterator</code>
+                  nor <code>const_iterator</code> are implicitly convertible from <code>K</code>. The library
+                  assumes that <code>Hash</code> is callable with both <code>K</code> and <code>Key</code> and
+                  that <code>Pred</code> is transparent. This enables heterogeneous lookup which avoids the cost of
+                  instantiating an instance of the <code>Key</code> type.
+                </para>
+              </description>
+            </method>            
             <method name="erase">
               <parameter name="first">
                 <paramtype>const_iterator</paramtype>