Tweaks in docs

Author: neatudarius

CMakeLists.txt

@@ -82,6 +82,7 @@ add_subdirectory(src/beman/iterator_interface)
 add_subdirectory(include/beman/iterator_interface)
 
 if(BEMAN_ITERATOR_INTERFACE_BUILD_TESTS)
+  enable_testing()
   add_subdirectory(tests/beman/iterator_interface)
 endif()
 

README.md

@@ -17,7 +17,7 @@ Documentation and associated papers are licensed with the Creative Commons Attri
 
 // SPDX-License-Identifier: CC-BY-4.0
 
-The intent is that the source and documentation are available for use by people implementing their iterator types as well as people using the iterator_interface presented here as-is.
+The intent is that the source and documentation are available for use by people implementing their iterator types.
 
 The README itself is licesed with CC0 1.0 Universal. Copy the contents and incorporate in your own work as you see fit.
 
@@ -164,15 +164,15 @@ Preset CMake variables:
 -- Found Threads: TRUE
 -- Configuring done (2.7s)
 -- Generating done (0.0s)
--- Build files have been written to: /home/dariusn/git/Beman/iterator_interface/.build/gcc-debug
+-- Build files have been written to: /path/to/repo/.build/gcc-debug
 
 Executing workflow step 2 of 3: build preset "gcc-debug"
 
 [15/15] Linking CXX executable tests/beman/iterator_interface/beman.iterator_interface.tests
 
 Executing workflow step 3 of 3: test preset "gcc-debug"
 
-Test project /home/dariusn/git/Beman/iterator_interface/.build/gcc-debug
+Test project /path/to/repo/.build/gcc-debug
     Start 1: IteratorTest.TestGTest
 1/4 Test #1: IteratorTest.TestGTest ...........   Passed    0.01 sec
     Start 2: IteratorTest.TestRepeatedChars
@@ -224,15 +224,15 @@ Preset CMake variables:
 -- Found Threads: TRUE
 -- Configuring done (2.7s)
 -- Generating done (0.0s)
--- Build files have been written to: /home/dariusn/git/Beman/iterator_interface/.build/gcc-release
+-- Build files have been written to: /path/to/repo/.build/gcc-release
 
 Executing workflow step 2 of 3: build preset "gcc-release"
 
 [15/15] Linking CXX executable tests/beman/iterator_interface/beman.iterator_interface.tests
 
 Executing workflow step 3 of 3: test preset "gcc-release"
 
-Test project /home/dariusn/git/Beman/iterator_interface/.build/gcc-release
+Test project /path/to/repo/.build/gcc-release
     Start 1: IteratorTest.TestGTest
 1/4 Test #1: IteratorTest.TestGTest ...........   Passed    0.00 sec
     Start 2: IteratorTest.TestRepeatedChars

examples/README.md

@@ -17,13 +17,13 @@ Check basic `beman.iterator_interface` library usages:
 
 ```shell
 # build
-$ cmake --workflow --preset gcc-14 # or choose one from --list-presets
+$ cmake --workflow --preset gcc-debug
 
 # run repeated_chars_iterator.cpp
-$ .build/gcc-14/examples/Asan/beman.iterator_interface.examples.repeated_chars_iterator 
+$ .build/gcc-debug/examples/beman.iterator_interface.examples.repeated_chars_iterator
 foofoof
 
 # run filter_int_iterator.cpp
-$ .build/gcc-14/examples/Asan/beman.iterator_interface.examples.filter_int_iterator
+$ .build/gcc-debug/examples/beman.iterator_interface.examples.filter_int_iterator
 2 4 10 200
 ```

examples/filter_int_iterator.cpp

@@ -3,6 +3,7 @@
 
 // [P2727](https://wg21.link/P2727) example:
 // An iterator that allows filtering int elements of a sequence.
+
 #include <beman/iterator_interface/iterator_interface.hpp>
 
 #include <algorithm>
@@ -25,7 +26,7 @@ struct filtered_int_iterator
     }
 
     // A forward iterator based on iterator_interface usually requires
-    // three user-defined operations.  since we are adapting an existing
+    // three user-defined operations.  Since we are adapting an existing
     // iterator (an int *), we only need to define this one.  The others are
     // implemented by iterator_interface, using the underlying int *.
     filtered_int_iterator& operator++() {
@@ -59,9 +60,9 @@ int main() {
     // skipping odd numbers. 0 is not skipped, so it will be the last element in the sequence.
     std::array a = {1, 2, 3, 4, 10, 11, 101, 200, 0};
     filtered_int_iterator it{std::begin(a), std::end(a), [](int i) { return i % 2 == 0; }};
-
-    while (*it) {
-        std::cout << *it << " ";
+    
+    while (*it) {                   // Expected output at STDOUT:
+        std::cout << *it << " ";    // 2 4 10 200 0
         ++it;
     }
     std::cout << "\n";

examples/repeated_chars_iterator.cpp

@@ -3,6 +3,7 @@
 
 // [P2727](https://wg21.link/P2727) example:
 // An iterator that allows iterating over repetitions of a sequence of characters.
+
 #include <beman/iterator_interface/iterator_interface.hpp>
 
 #include <algorithm>
@@ -50,7 +51,7 @@ int main() {
     constexpr const std::string_view target = "foo";
     constexpr const auto len = 7;                                        // Number of extracted characters from the sequence.
 
-    // Create iterators that iterate over the sequence "foofoofoofoofoofoo...".
+    // Create iterators that go over the sequence "foofoofoofoofoofoo...".
     repeated_chars_iterator it_first(target.data(), target.size(), 0);   // target.size() == 3 is the length of "foo", 0 is this iterator's position.
     repeated_chars_iterator it_last(target.data(), target.size(), len);  // Same as above, but now the iterator's position is 7.