test(Runtime Integration Tests): Crowdloan Rewards Tests added docume…

…ntation.

integration-tests/runtime-tests/test/tests/crowdloanRewards/txCrowdloanRewardsTests.ts

@@ -24,7 +24,8 @@ const ethAccount = (seed: number) =>
  *  1. Provide funds to crowdloan pallet
  *  2. Populate the list of contributors
  *  3. Initialize the crowdloan
- *  4. Associate a picassso account
+ *  4. Associate a picassso account (which also claims)
+ *  5. Claiming more rewards.
  */
 describe('CrowdloanRewards Tests', function() {
   if (!testConfiguration.enabledTests.tx.enabled)
@@ -84,7 +85,7 @@ describe('CrowdloanRewards Tests', function() {
   /**
    * Here we populate the crowdloan pallet with a random generated list of contributors.
    *
-   * Sudo call! Checked with `.isOk`.
+   * This is a SUDO call and is checked with `.isOk`.
    */
   it('Can populate the list of contributors', async function() {
     if (!testConfiguration.enabledTests.tx.populate_success.populate1 || onExistingChain)
@@ -95,6 +96,11 @@ describe('CrowdloanRewards Tests', function() {
     expect(result.isOk).to.be.true;
   });
 
+  /**
+   * Here we initialize the crowdloan with our populated list of contributors.
+   *
+   * This is a SUDO call and is checked with `.isOk`.
+   */
   it('Can initialize the crowdloan', async function() {
     if (!testConfiguration.enabledTests.tx.initialize_success.initialize1 || onExistingChain)
       this.skip();