chore: cleanup comments

contracts/subdaos/cwd-subdao-core/src/lib.rs

@@ -8,7 +8,7 @@
 //! [this](https://!github.com/DA0-DA0/dao-contracts/wiki/DAO-DAO-v1-Contracts-Design)
 //! wiki page.
 //!
-//! In additon to the wiki spec this contract may also pause. To do so a
+//! In addition to the wiki spec this contract may also pause. To do so a
 //! `Pause` message must by executed by a proposal module. Pausing the
 //! core module will stop all actions on the module for the duration of
 //! the pause.

contracts/tokenomics/distribution/schema/neutron-distribution.json

@@ -13,6 +13,7 @@
     ],
     "properties": {
       "denom": {
+        "description": "Denom used for rewards distribution. All funds in any other denoms will be ignored.",
         "type": "string"
       },
       "main_dao_address": {
@@ -43,6 +44,7 @@
         "additionalProperties": false
       },
       {
+        "description": "Alter shareholder's weights",
         "type": "object",
         "required": [
           "set_shares"
@@ -76,7 +78,7 @@
         "additionalProperties": false
       },
       {
-        "description": "Distribute funds between share holders. It is called from reserve contract only when part of the fund is going to distribution betrween share holders.",
+        "description": "Distribute funds between share holders. It is called from reserve contract only when part of the fund is going to distribution between share holders.",
         "type": "object",
         "required": [
           "fund"
@@ -162,6 +164,7 @@
         "additionalProperties": false
       },
       {
+        "description": "List of pending funds to addresses (to be distributed); returns [`Vec<(Addr, Uint128)>`]",
         "type": "object",
         "required": [
           "pending"
@@ -175,6 +178,7 @@
         "additionalProperties": false
       },
       {
+        "description": "List of current shareholder weights; returns [`Vec<(Addr, Uint128)>`]",
         "type": "object",
         "required": [
           "shares"

contracts/tokenomics/distribution/schema/raw/execute.json

@@ -16,6 +16,7 @@
       "additionalProperties": false
     },
     {
+      "description": "Alter shareholder's weights",
       "type": "object",
       "required": [
         "set_shares"
@@ -49,7 +50,7 @@
       "additionalProperties": false
     },
     {
-      "description": "Distribute funds between share holders. It is called from reserve contract only when part of the fund is going to distribution betrween share holders.",
+      "description": "Distribute funds between share holders. It is called from reserve contract only when part of the fund is going to distribution between share holders.",
       "type": "object",
       "required": [
         "fund"

contracts/tokenomics/distribution/schema/raw/instantiate.json

@@ -9,6 +9,7 @@
   ],
   "properties": {
     "denom": {
+      "description": "Denom used for rewards distribution. All funds in any other denoms will be ignored.",
       "type": "string"
     },
     "main_dao_address": {

contracts/tokenomics/distribution/schema/raw/query.json

@@ -17,6 +17,7 @@
       "additionalProperties": false
     },
     {
+      "description": "List of pending funds to addresses (to be distributed); returns [`Vec<(Addr, Uint128)>`]",
       "type": "object",
       "required": [
         "pending"
@@ -30,6 +31,7 @@
       "additionalProperties": false
     },
     {
+      "description": "List of current shareholder weights; returns [`Vec<(Addr, Uint128)>`]",
       "type": "object",
       "required": [
         "shares"

contracts/tokenomics/distribution/src/msg.rs

@@ -7,6 +7,7 @@ use serde::{Deserialize, Serialize};
 
 #[derive(Serialize, Deserialize, Clone, Debug, PartialEq, Eq, JsonSchema)]
 pub struct InstantiateMsg {
+    /// Denom used for rewards distribution. All funds in any other denoms will be ignored.
     pub denom: String,
     /// The address of the main DAO. It's capable of pausing and unpausing the contract
     pub main_dao_address: String,
@@ -21,12 +22,11 @@ pub enum ExecuteMsg {
     /// Transfer the contract's ownership to another account
     TransferOwnership(String),
 
-    SetShares {
-        shares: Vec<(String, Uint128)>,
-    },
+    /// Alter shareholder's weights
+    SetShares { shares: Vec<(String, Uint128)> },
 
     /// Distribute funds between share holders. It is called from reserve contract only
-    /// when part of the fund is going to distribution betrween share holders.
+    /// when part of the fund is going to distribution between share holders.
     Fund {},
 
     /// Claim the funds that have been distributed to the contract's account
@@ -40,8 +40,10 @@ pub enum QueryMsg {
     /// The contract's configurations; returns [`ConfigResponse`]
     #[returns(crate::state::Config)]
     Config {},
+    /// List of pending funds to addresses (to be distributed); returns [`Vec<(Addr, Uint128)>`]
     #[returns(Vec<(Addr, Uint128)>)]
     Pending {},
+    /// List of current shareholder weights; returns [`Vec<(Addr, Uint128)>`]
     #[returns(Vec<(Addr, Uint128)>)]
     Shares {},
 }

contracts/tokenomics/distribution/src/state.rs

@@ -14,11 +14,15 @@ pub struct Config {
 
 /// Map to store the amount of funds that are pending distribution to a given address
 pub const PENDING_DISTRIBUTION: Map<Addr, Uint128> = Map::new("pending_distribution");
+
 /// Map to store the amount of shares that a given address has
 pub const SHARES: Map<Addr, Uint128> = Map::new("shares");
 
+/// Stores contract's configuration
 pub const CONFIG: Item<Config> = Item::new("config");
 
+/// Counts times `Fund` has been called successfully.
+/// Used to determine what address to fund non-dividable remainder after weight distribution.
 pub const FUND_COUNTER: Item<u64> = Item::new("fund_counter");
 
 /// The height the contract is paused until. If it's None, the contract is not paused.

contracts/tokenomics/reserve/schema/neutron-reserve.json

@@ -18,6 +18,7 @@
     ],
     "properties": {
       "denom": {
+        "description": "Denom of the main coin",
         "type": "string"
       },
       "distribution_contract": {
@@ -33,6 +34,7 @@
         ]
       },
       "main_dao_address": {
+        "description": "Address of the Neutron DAO contract",
         "type": "string"
       },
       "min_period": {
@@ -94,6 +96,7 @@
         "additionalProperties": false
       },
       {
+        "description": "Update config",
         "type": "object",
         "required": [
           "update_config"
@@ -212,6 +215,7 @@
         "additionalProperties": false
       },
       {
+        "description": "The contract's current stats; returns [`StatsResponse`]",
         "type": "object",
         "required": [
           "stats"
@@ -375,13 +379,28 @@
       ],
       "properties": {
         "total_distributed": {
-          "$ref": "#/definitions/Uint128"
+          "description": "Amount of coins distributed since contract instantiation",
+          "allOf": [
+            {
+              "$ref": "#/definitions/Uint128"
+            }
+          ]
         },
         "total_processed_burned_coins": {
-          "$ref": "#/definitions/Uint128"
+          "description": "Total amount of burned coins processed by reserve contract",
+          "allOf": [
+            {
+              "$ref": "#/definitions/Uint128"
+            }
+          ]
         },
         "total_reserved": {
-          "$ref": "#/definitions/Uint128"
+          "description": "Amount of coins reserved since contract instantiation",
+          "allOf": [
+            {
+              "$ref": "#/definitions/Uint128"
+            }
+          ]
         }
       },
       "definitions": {

contracts/tokenomics/reserve/schema/raw/execute.json

@@ -29,6 +29,7 @@
       "additionalProperties": false
     },
     {
+      "description": "Update config",
       "type": "object",
       "required": [
         "update_config"

contracts/tokenomics/reserve/schema/raw/instantiate.json

@@ -14,6 +14,7 @@
   ],
   "properties": {
     "denom": {
+      "description": "Denom of the main coin",
       "type": "string"
     },
     "distribution_contract": {
@@ -29,6 +30,7 @@
       ]
     },
     "main_dao_address": {
+      "description": "Address of the Neutron DAO contract",
       "type": "string"
     },
     "min_period": {