pw_bytes: Add example to docs of using _b suffix
Change-Id: I25ade6c2fda0bb7aa139cef90e682dc13c70ba32
Reviewed-on: https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/201350
Commit-Queue: Jonathon Reinhart <jrreinhart@google.com>
Presubmit-Verified: CQ Bot Account <pigweed-scoped@luci-project-accounts.iam.gserviceaccount.com>
Reviewed-by: Taylor Cramer <cramertj@google.com>
diff --git a/pw_bytes/docs.rst b/pw_bytes/docs.rst
index 8f841f1..21befa3 100644
--- a/pw_bytes/docs.rst
+++ b/pw_bytes/docs.rst
@@ -66,6 +66,21 @@
.. cpp:function:: constexpr std::byte operator"" _b(unsigned long long value)
+.. note::
+ This should not be used in header files, as it requires a ``using``
+ declaration that will be publicly exported at whatever level it is
+ used.
+
+Example:
+
+.. code-block:: cpp
+
+ #include "pw_bytes/units.h"
+
+ using ::pw::operator""_b;
+
+ constexpr std::byte kValue = 5_b;
+
pw_bytes/units.h
================
Constants, functions and user-defined literals for specifying a number of bytes
