Update documentation

nlohmann · Aug 7, 2022 · 05f30df · 05f30df
1 parent c253208
commit 05f30df
Show file tree

Hide file tree

Showing 2 changed files with 12 additions and 2 deletions.
diff --git a/docs/mkdocs/docs/api/json_pointer/operator_eq.md b/docs/mkdocs/docs/api/json_pointer/operator_eq.md
@@ -71,6 +71,12 @@ whether the values `lhs`/`*this` and `rhs` are equal
 Constant if `lhs` and `rhs` differ in the number of reference tokens, otherwise linear in the number of reference
 tokens.
 
+## Notes
+
+!!! warning "Deprecation"
+
+    Overload 2 is deprecated and will be removed in a future major version release.
+
 ## Examples
 
 ??? example "Example: (1) Comparing JSON pointers"
@@ -104,4 +110,4 @@ tokens.
 ## Version history
 
 1. Added in version 2.1.0. Added C++20 member functions in version 3.11.2.
-2. Added in version 3.11.2.
+2. Added for backward compatibility and deprecated in version 3.11.2.
diff --git a/docs/mkdocs/docs/api/json_pointer/operator_ne.md b/docs/mkdocs/docs/api/json_pointer/operator_ne.md
@@ -69,6 +69,10 @@ tokens.
     Since C++20 overload resolution will consider the _rewritten candidate_ generated from
     [`operator==`](operator_eq.md).
 
+!!! warning "Deprecation"
+
+    Overload 2 is deprecated and will be removed in a future major version release.
+
 ## Examples
 
 ??? example "Example: (1) Comparing JSON pointers"
@@ -102,4 +106,4 @@ tokens.
 ## Version history
 
 1. Added in version 2.1.0.
-2. Added in version 3.11.2.
+2. Added for backward compatibility and deprecated in version 3.11.2.