Clarify documentation

nlohmann · Aug 1, 2022 · cb2b535 · cb2b535
1 parent fbd1f9e
commit cb2b535
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 6 deletions.
diff --git a/docs/mkdocs/docs/api/operator_literal_json.md b/docs/mkdocs/docs/api/operator_literal_json.md
@@ -7,16 +7,16 @@ json operator "" _json(const char* s, std::size_t n);
 This operator implements a user-defined string literal for JSON objects. It can be used by adding `#!cpp _json` to a
 string literal and returns a [`json`](json.md) object if no parse error occurred.
 
-Use any of the following lines to bring the operator into scope:
+It is recommended to bring the operator into scope using any of the following lines:
 ```cpp
 using namespace nlohmann::literals;
 using namespace nlohmann::json_literals;
 using namespace nlohmann::literals::json_literals;
 using namespace nlohmann;
 ```
+This is not required but recommended to ease migration to the next major version release of the library. See 
+See ['JSON_USE_GLOBAL_UDLS`](macros/json_use_global_udls.md#notes) for details.
 
-Alternatively, define [`JSON_USE_GLOBAL_UDLS`](macros/json_use_global_udls.md) to make them available in the global
-namespace.
 ## Parameters
 
 `s` (in)

diff --git a/docs/mkdocs/docs/api/operator_literal_json_pointer.md b/docs/mkdocs/docs/api/operator_literal_json_pointer.md
@@ -7,16 +7,16 @@ json_pointer operator "" _json_pointer(const char* s, std::size_t n);
 This operator implements a user-defined string literal for JSON Pointers. It can be used by adding `#!cpp _json_pointer`
 to a string literal and returns a [`json_pointer`](json_pointer/index.md) object if no parse error occurred.
 
-Use any of the following lines to bring the operator into scope:
+It is recommended to bring the operator into scope using any of the following lines:
 ```cpp
 using namespace nlohmann::literals;
 using namespace nlohmann::json_literals;
 using namespace nlohmann::literals::json_literals;
 using namespace nlohmann;
 ```
+This is not required but recommended to ease migration to the next major version release of the library. See 
+See ['JSON_USE_GLOBAL_UDLS`](macros/json_use_global_udls.md#notes) for details.
 
-Alternatively, define [`JSON_USE_GLOBAL_UDLS`](macros/json_use_global_udls.md) to make them available in the global
-namespace.
 ## Parameters
 
 `s` (in)