pw_result: Add some size reports
This adds some simple size reports to the result module to provide some
data on how it compares to traditional function prototypes.
Change-Id: I711fa5d04ff5720ed3184b6250f3993606bd34ec
Reviewed-on: https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/17162
Commit-Queue: Alexei Frolov <frolv@google.com>
Reviewed-by: Alexei Frolov <frolv@google.com>
Reviewed-by: Wyatt Hepler <hepler@google.com>
Reviewed-by: Keir Mierle <keir@google.com>
diff --git a/pw_result/docs.rst b/pw_result/docs.rst
index 5671d8a..02d6854 100644
--- a/pw_result/docs.rst
+++ b/pw_result/docs.rst
@@ -24,3 +24,15 @@
Compatibility
=============
Works with C++11, but some features require C++17.
+
+Size report
+===========
+The table below showcases the difference in size between functions returning a
+Status with an output pointer, and functions returning a Result, in various
+situations.
+
+Note that these are simplified examples which do not necessarily reflect the
+usage of Result in real code. Make sure to always run your own size reports to
+check if Result is suitable for you.
+
+.. include:: result_size