cleaned up documentation

Author: jkalias

README.md

@@ -310,7 +310,7 @@ const auto colleagues_but_not_friends = colleagues.difference_with(friends);
 // find which friends are colleagues
 // same as colleagues.intersect_with(friends)
 // contains person(51, "George"), person(41, "Jackie")
-const auto good_colleagues = friends.intersection_with(colleagues);
+const auto good_colleagues = friends.intersect_with(colleagues);
 
 // a set of close family members
 const fcpp::set<person, person_comparator> family({
@@ -322,8 +322,8 @@ const fcpp::set<person, person_comparator> family({
 // contains person(51, "George"), person(41, "Jackie"), person(42, "Crystal"), person(51, "Paul"), person(81, "Barbara") 
 const auto friends_and_family = friends.union_with(family);
 
-// all set keys in a vetor
-const fcpp::vector<person> = friends_and_family.keys();
+// all set keys in a vector
+const auto people = friends_and_family.keys();
 ```
 
 ### zip, map, filter, reduce

include/set.h

@@ -34,7 +34,7 @@ namespace fcpp {
     // of the standard library algorithms.
     //
     // Member functions can be mutating (eg. my_set.insert()) or
-    // non-mutating (eg. my_vector.inserting()) enforcing thread safety if needed
+    // non-mutating (eg. my_set.inserting()) enforcing thread safety if needed
     template <class TKey, class TCompare = std::less<TKey>>
     class set
     {
@@ -71,7 +71,7 @@ namespace fcpp {
         // example:
         //      const fcpp::set<int> set1(std::set<int>({1, 2, 3, 5, 7, 8, 10}));
         //      const fcpp::set<int> set2(std::set<int>({2, 5, 7, 10, 15, 17}));
-        //      const auto& diff = set1.difference(set2);
+        //      const auto& diff = set1.difference_with(set2);
         //
         // outcome:
         //      diff -> fcpp::set<int>({1, 3, 8})
@@ -98,7 +98,7 @@ namespace fcpp {
         // example:
         //      const fcpp::set<int> set1(std::set<int>({1, 2, 3, 5, 7, 8, 10}));
         //      const fcpp::set<int> set2(std::set<int>({2, 5, 7, 10, 15, 17}));
-        //      const auto& combined = set1.set_union(set2);
+        //      const auto& combined = set1.union_with(set2);
         //
         // outcome:
         //      combined -> fcpp::set<int>({1, 2, 3, 5, 7, 8, 10, 15, 17})
@@ -125,7 +125,7 @@ namespace fcpp {
         // example:
         //      const fcpp::set<int> set1(std::set<int>({1, 2, 3, 5, 7, 8, 10}));
         //      const fcpp::set<int> set2(std::set<int>({2, 5, 7, 10, 15, 17}));
-        //      const auto& combined = set1.set_union(set2);
+        //      const auto& combined = set1.intersect_with(set2);
         //
         // outcome:
         //      combined -> fcpp::set<int>({2, 5, 7, 10})
@@ -191,7 +191,7 @@ namespace fcpp {
         // output of applying the transform function on every element of this instance.
         //
         // example:
-        //      const fcpp::vector<int> input_set({ 1, 3, -5 });
+        //      const fcpp::set<int> input_set({ 1, 3, -5 });
         //      const auto output_set = input_set.map<std::string>([](const int& element) {
         //          return std::to_string(element);
         //      });
@@ -299,7 +299,7 @@ namespace fcpp {
         }
 
         // Performs the functional `reduce` (fold/accumulate) algorithm, by returning the result of
-        // accumulating all the values in the vector to an initial value. (non-mutating)
+        // accumulating all the values in the set to an initial value. (non-mutating)
         //
         // example:
         //      const fcpp::set<std::string> tokens({ "the", "quick", "brown", "fox", "jumps", "over", "the", "lazy", "brown", "dog" });
@@ -598,7 +598,7 @@ namespace fcpp {
             return m_set.count(key) != 0;
         }
 
-        // Returns the size of the vector (how many elements it contains, it may be different from its capacity)
+        // Returns the size of the set (how many elements it contains, it may be different from its capacity)
         [[nodiscard]] size_t size() const
         {
             return m_set.size();

include/vector.h

@@ -604,7 +604,7 @@ namespace fcpp {
         //
         // example:
         //      fcpp::vector numbers({3, 1, 9, -4});
-        //      numbers.sort_ascending();
+        //      numbers.sort_descending();
         //
         // outcome:
         //      numbers -> fcpp::vector({9, 3, 1, -4});
@@ -614,7 +614,7 @@ namespace fcpp {
         }
 
 #ifdef PARALLEL_ALGORITHM_AVAILABLE
-        // Performs the `sort_ascending` algorithm in parallel.
+        // Performs the `sort_descending` algorithm in parallel.
         // See also the sequential version for more documentation.
         vector& sort_descending_parallel()
         {