comment cleanup

AztecProtocol · Apr 18, 2024 · fbd8f7e · fbd8f7e
1 parent 8db24ee
commit fbd8f7e
Show file tree

Hide file tree

Showing 9 changed files with 9 additions and 10 deletions.
diff --git a/barretenberg/cpp/src/barretenberg/relations/auxiliary_relation.hpp b/barretenberg/cpp/src/barretenberg/relations/auxiliary_relation.hpp
@@ -50,7 +50,7 @@ template <typename FF_> class AuxiliaryRelationImpl {
     };
 
     /**
-     * @brief Returns true if the contribution from all subrelation for the provided inputs is identically zero
+     * @brief Returns true if the contribution from all subrelations for the provided inputs is identically zero
      *
      */
     template <typename AllEntities> inline static bool skip(const AllEntities& in)

diff --git a/barretenberg/cpp/src/barretenberg/relations/delta_range_constraint_relation.hpp b/barretenberg/cpp/src/barretenberg/relations/delta_range_constraint_relation.hpp
@@ -15,7 +15,7 @@ template <typename FF_> class DeltaRangeConstraintRelationImpl {
     };
 
     /**
-     * @brief Returns true if the contribution from all subrelation for the provided inputs is identically zero
+     * @brief Returns true if the contribution from all subrelations for the provided inputs is identically zero
      *
      */
     template <typename AllEntities> inline static bool skip(const AllEntities& in)

diff --git a/barretenberg/cpp/src/barretenberg/relations/elliptic_relation.hpp b/barretenberg/cpp/src/barretenberg/relations/elliptic_relation.hpp
@@ -15,7 +15,7 @@ template <typename FF_> class EllipticRelationImpl {
     };
 
     /**
-     * @brief Returns true if the contribution from all subrelation for the provided inputs is identically zero
+     * @brief Returns true if the contribution from all subrelations for the provided inputs is identically zero
      *
      */
     template <typename AllEntities> inline static bool skip(const AllEntities& in)

diff --git a/barretenberg/cpp/src/barretenberg/relations/lookup_relation.hpp b/barretenberg/cpp/src/barretenberg/relations/lookup_relation.hpp
@@ -33,7 +33,7 @@ template <typename FF_> class LookupRelationImpl {
     };
 
     /**
-     * @brief Returns true if the contribution from all subrelation for the provided inputs is identically zero
+     * @brief Returns true if the contribution from all subrelations for the provided inputs is identically zero
      *
      */
     template <typename AllEntities> inline static bool skip([[maybe_unused]] const AllEntities& in)

diff --git a/barretenberg/cpp/src/barretenberg/relations/permutation_relation.hpp b/barretenberg/cpp/src/barretenberg/relations/permutation_relation.hpp
@@ -18,7 +18,7 @@ template <typename FF_> class UltraPermutationRelationImpl {
     };
 
     /**
-     * @brief Returns true if the contribution from all subrelation for the provided inputs is identically zero
+     * @brief Returns true if the contribution from all subrelations for the provided inputs is identically zero
      *
      */
     template <typename AllEntities> inline static bool skip(const AllEntities& in)
@@ -27,7 +27,6 @@ template <typename FF_> class UltraPermutationRelationImpl {
         // non-trivial copy constraints.
         return (in.z_perm.value_at(0) == in.z_perm_shift.value_at(0) &&
                 in.z_perm.value_at(1) == in.z_perm_shift.value_at(1));
-        // return true;
     }
 
     inline static auto& get_grand_product_polynomial(auto& in) { return in.z_perm; }

diff --git a/barretenberg/cpp/src/barretenberg/relations/poseidon2_external_relation.hpp b/barretenberg/cpp/src/barretenberg/relations/poseidon2_external_relation.hpp
@@ -14,7 +14,7 @@ template <typename FF_> class Poseidon2ExternalRelationImpl {
     };
 
     /**
-     * @brief Returns true if the contribution from all subrelation for the provided inputs is identically zero
+     * @brief Returns true if the contribution from all subrelations for the provided inputs is identically zero
      *
      */
     template <typename AllEntities> inline static bool skip(const AllEntities& in)

diff --git a/barretenberg/cpp/src/barretenberg/relations/poseidon2_internal_relation.hpp b/barretenberg/cpp/src/barretenberg/relations/poseidon2_internal_relation.hpp
@@ -16,7 +16,7 @@ template <typename FF_> class Poseidon2InternalRelationImpl {
     };
 
     /**
-     * @brief Returns true if the contribution from all subrelation for the provided inputs is identically zero
+     * @brief Returns true if the contribution from all subrelations for the provided inputs is identically zero
      *
      */
     template <typename AllEntities> inline static bool skip(const AllEntities& in)

diff --git a/barretenberg/cpp/src/barretenberg/relations/relation_types.hpp b/barretenberg/cpp/src/barretenberg/relations/relation_types.hpp
@@ -113,7 +113,7 @@ consteval std::array<size_t, NUM_SUBRELATIONS> compute_composed_subrelation_part
 
 /**
  * @brief Check if the relation has a static skip method to determine if accumulation of its result can be
- * optimised based on a single check
+ * optimised away based on a single check
  *
  * @details The skip function should return true if relation can be skipped and false if it can't
  * @tparam Relation The relation type

diff --git a/barretenberg/cpp/src/barretenberg/relations/ultra_arithmetic_relation.hpp b/barretenberg/cpp/src/barretenberg/relations/ultra_arithmetic_relation.hpp
@@ -13,7 +13,7 @@ template <typename FF_> class UltraArithmeticRelationImpl {
     };
 
     /**
-     * @brief Returns true if the contribution from all subrelation for the provided inputs is identically zero
+     * @brief Returns true if the contribution from all subrelations for the provided inputs is identically zero
      *
      */
     template <typename AllEntities> inline static bool skip(const AllEntities& in)