commit 6573187ae15c0c7897442a48d3c6e2dc581c57a1
author Prashanth Swaminathan <prashanthsw@google.com> Thu Feb 11 08:51:08 2021 -0800
committer CQ Bot Account <pigweed-scoped@luci-project-accounts.iam.gserviceaccount.com> Wed Feb 17 21:46:52 2021 +0000
tree 508da3abdb58f1fe202e0f136faea02e5148efd4
parent 625a232c7aa905dbbb54f87ea2868abf55effc72

pw_containers: Fix namespace in documentation

IntrusiveList is part of the top-level 'pw' namespace, instead of the
'pw::containers' namespace, which some of the documentation refers to.

Change-Id: Iec09fdd579783db0ea74aed49978e92555a6b43a
Reviewed-on: https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/32580
Pigweed-Auto-Submit: Prashanth Swaminathan <prashanthsw@google.com>
Reviewed-by: Rob Mohr <mohrr@google.com>
Commit-Queue: Prashanth Swaminathan <prashanthsw@google.com>

pw_containers/docs.rst

diff --git a/pw_containers/docs.rst b/pw_containers/docs.rst
index a4ffafa..f875ce4 100644
--- a/pw_containers/docs.rst
+++ b/pw_containers/docs.rst
@@ -65,7 +65,7 @@
 .. code-block:: cpp
 
   class Square
-     : public pw::containers::IntrusiveList<Square>::Item {
+     : public pw::IntrusiveList<Square>::Item {
    public:
     Square(unsigned int side_length) : side_length(side_length) {}
     unsigned long Area() { return side_length * side_length; }
@@ -74,7 +74,7 @@
     unsigned int side_length;
   };
 
-  pw::containers::IntrusiveList<Square> squares;
+  pw::IntrusiveList<Square> squares;
 
   Square small(1);
   Square large(4000);

pw_containers/public/pw_containers/intrusive_list.h

diff --git a/pw_containers/public/pw_containers/intrusive_list.h b/pw_containers/public/pw_containers/intrusive_list.h
index 4b6bae4..b73effe 100644
--- a/pw_containers/public/pw_containers/intrusive_list.h
+++ b/pw_containers/public/pw_containers/intrusive_list.h
@@ -38,9 +38,9 @@
 // Usage:
 //
 //   class TestItem
-//      : public containers::IntrusiveList<TestItem>::Item {}
+//      : public IntrusiveList<TestItem>::Item {}
 //
-//   containers::IntrusiveList<TestItem> test_items;
+//   IntrusiveList<TestItem> test_items;
 //
 //   auto item = TestItem();
 //   test_items.push_back(item);