update documentation

pallets/distance/README.md

@@ -6,14 +6,14 @@ The pallet then selects the median of the results (reach perbill) of an evaluati
 The status of an identity can be:
 
 - inexistant: distance evaluation has not been requested or has expired
-- pending: distance evaluation for this identity has been requested and is waiting two sessions for results
+- pending: distance evaluation for this identity has been requested and is waiting two evaluation periods for results
 - valid: distance has been evaluated positively for this identity
 
 The result of the evaluation is used by `duniter-wot` pallet to determine if an identity can get / should loose membership to the web of trust.
 
 ## Process
 
-Any account can request a distance evaluation for a given identity provided it has enough currency to be reserved. In this case, the distance status is marked as pending and in the next session, inherents can start to publish results. 
+Any account can request a distance evaluation for a given identity provided it has enough currency to be reserved. In this case, the distance status is marked as pending and in the next evaluation period, inherents can start to publish results.
 
 This is how a result is published:
 
@@ -23,10 +23,10 @@ This is how a result is published:
 1. the result is added to the current evaluation pool
 1. a flag is set to prevent other distance evaluation in the same block
 
-On each new session:
+On each new evaluation period:
 
-1. old results set to expire at this session do expire
-1. results from the current pool (previous session's result pool) are taken and for each identity
+1. old results set to expire at this period do expire
+1. results from the current pool (previous period's result pool) are taken and for each identity
     - the median of the distance results for this identity is chosen
     - if the distance is ok, the distance is marked as valid
     - if the distance is ko, the result for this identity is removed and reserved currency is slashed (from the account which requested the evaluation)
@@ -40,8 +40,8 @@ Evaluation pools are made of two components:
 - a set of evaluators
 - a vec of results
 
-The evaluation are separated in three pools (N - 2 is the session index):
+The evaluation are separated in three pools:
 
-- pool number N - 1 % 3: results from the previous session used in the current one (let empty for next session)
+- pool number N - 1 % 3: results from the previous evaluation period used in the current one (let empty for next evaluation period)
 - pool number N + 0 % 3: inherent results are added there
 - pool number N + 1 % 3: identities are added there for evaluation

pallets/distance/src/lib.rs

@@ -45,9 +45,9 @@ use sp_std::prelude::*;
 
 type IdtyIndex = u32;
 
-/// Maximum number of identities to be evaluated in a session
+/// Maximum number of identities to be evaluated in an evaluation period.
 pub const MAX_EVALUATIONS_PER_SESSION: u32 = 600;
-/// Maximum number of evaluators in a session
+/// Maximum number of evaluators in an evaluation period.
 pub const MAX_EVALUATORS_PER_SESSION: u32 = 100;
 
 #[frame_support::pallet()]
@@ -162,13 +162,6 @@ pub mod pallet {
     #[pallet::storage]
     pub(super) type CurrentPoolIndex<T: Config> = StorageValue<_, u32, ValueQuery>;
 
-    // session_index % 3:
-    //   storage_id + 0 => pending
-    //   storage_id + 1 => receives results
-    //   storage_id + 2 => receives new identities
-    // (this avoids problems for session_index < 3)
-    //
-
     #[pallet::event]
     #[pallet::generate_deposit(pub(super) fn deposit_event)]
     pub enum Event<T: Config> {
@@ -328,8 +321,8 @@ pub mod pallet {
 
     impl<T: Config> Pallet<T> {
         /// Mutate the evaluation pool containing:
-        /// * when this session begins: the evaluation results to be applied
-        /// * when this session ends: the evaluation requests
+        /// * when this period begins: the evaluation results to be applied.
+        /// * when this period ends: the evaluation requests.
         fn mutate_current_pool<
             R,
             F: FnOnce(
@@ -350,7 +343,7 @@ pub mod pallet {
             }
         }
 
-        /// Mutate the evaluation pool containing the results sent by evaluators on this session.
+        /// Mutate the evaluation pool containing the results sent by evaluators on this period.
         fn mutate_next_pool<
             R,
             F: FnOnce(
@@ -372,8 +365,8 @@ pub mod pallet {
         }
 
         /// Take (and leave empty) the evaluation pool containing:
-        /// * when this session begins: the evaluation results to be applied
-        /// * when this session ends: the evaluation requests
+        /// * when this period begins: the evaluation results to be applied.
+        /// * when this period ends: the evaluation requests.
         #[allow(clippy::type_complexity)]
         fn take_current_pool(
             index: u32,
@@ -527,8 +520,8 @@ pub mod pallet {
             // set evaluation block
             EvaluationBlock::<T>::set(frame_system::Pallet::<T>::parent_hash());
 
-            // Apply the results from the current pool (which was previous session's result pool)
-            // We take the results so the pool is left empty for the new session.
+            // Apply the results from the current pool (which was previous period's result pool)
+            // We take the results so the pool is left empty for the new period.
             #[allow(clippy::type_complexity)]
             let current_pool: EvaluationPool<
                 <T as frame_system::Config>::AccountId,

runtime/gdev/tests/integration_tests.rs

@@ -370,7 +370,7 @@ fn test_validate_identity_when_claim() {
                     distances: vec![Perbill::one()],
                 }
             ));
-            // Pass 3rd evalaution period
+            // Pass 3rd evaluation period
             run_to_block(3 * eval_period);
             System::assert_has_event(RuntimeEvent::Distance(
                 pallet_distance::Event::EvaluatedValid { idty_index: 5 },