Update doc comments for clippy

Author: joncinque

governance/program/src/lib.rs

@@ -1,4 +1,5 @@
 #![allow(clippy::arithmetic_side_effects)]
+#![allow(clippy::doc_lazy_continuation)]
 #![deny(missing_docs)]
 //! A Governance program for the Solana blockchain.
 

libraries/type-length-value/src/state.rs

@@ -375,8 +375,7 @@ impl<'data> TlvStateMut<'data> {
 
     /// Packs the default TLV data into the first open slot in the data buffer.
     /// Handles repetition based on the boolean arg provided:
-    /// * `true`:   If extension is already found in the buffer,
-    /// it returns an error.
+    /// * `true`:   If extension is already found in the buffer, it returns an error.
     /// * `false`:  Will add a new entry to the next open slot.
     pub fn init_value<V: SplDiscriminate + Pod + Default>(
         &mut self,

stake-pool/program/src/instruction.rs

@@ -192,11 +192,14 @@ pub enum StakePoolInstruction {
     /// 11. `[]` Stake Config sysvar
     /// 12. `[]` System program
     /// 13. `[]` Stake program
-    ///  userdata: amount of lamports to increase on the given validator.
-    ///  The actual amount split into the transient stake account is:
-    ///  `lamports + stake_rent_exemption`
-    ///  The rent-exemption of the stake account is withdrawn back to the
-    /// reserve  after it is merged.
+    ///
+    /// userdata: amount of lamports to increase on the given validator.
+    ///
+    /// The actual amount split into the transient stake account is:
+    /// `lamports + stake_rent_exemption`.
+    ///
+    /// The rent-exemption of the stake account is withdrawn back to the
+    /// reserve after it is merged.
     IncreaseValidatorStake {
         /// amount of lamports to increase on the given validator
         lamports: u64,
@@ -329,6 +332,7 @@ pub enum StakePoolInstruction {
     ///  10. `[]` Sysvar clock account (required)
     ///  11. `[]` Pool token program id
     ///  12. `[]` Stake program id,
+    ///
     ///  userdata: amount of pool tokens to withdraw
     WithdrawStake(u64),
 
@@ -463,11 +467,14 @@ pub enum StakePoolInstruction {
     /// 11. `[]` Stake Config sysvar
     /// 12. `[]` System program
     /// 13. `[]` Stake program
-    ///  userdata: amount of lamports to increase on the given validator.
-    ///  The actual amount split into the transient stake account is:
-    ///  `lamports + stake_rent_exemption`
-    ///  The rent-exemption of the stake account is withdrawn back to the
-    /// reserve  after it is merged.
+    ///
+    /// userdata: amount of lamports to increase on the given validator.
+    ///
+    /// The actual amount split into the transient stake account is:
+    /// `lamports + stake_rent_exemption`.
+    ///
+    /// The rent-exemption of the stake account is withdrawn back to the
+    /// reserve after it is merged.
     IncreaseAdditionalValidatorStake {
         /// amount of lamports to increase on the given validator
         lamports: u64,
@@ -674,6 +681,7 @@ pub enum StakePoolInstruction {
     ///  10. `[]` Sysvar clock account (required)
     ///  11. `[]` Pool token program id
     ///  12. `[]` Stake program id,
+    ///
     ///  userdata: amount of pool tokens to withdraw
     WithdrawStakeWithSlippage {
         /// Pool tokens to burn in exchange for lamports

token-lending/program/src/instruction.rs

@@ -158,8 +158,8 @@ pub enum LendingInstruction {
     ///
     ///   0. `[writable]` Obligation account.
     ///   1. `[]` Clock sysvar.
-    /// .. `[]` Collateral deposit reserve accounts - refreshed, all, in order.
-    /// .. `[]` Liquidity borrow reserve accounts - refreshed, all, in order.
+    ///   2. .. `[]` Collateral deposit reserve accounts - refreshed, all, in order.
+    ///   3. .. `[]` Liquidity borrow reserve accounts - refreshed, all, in order.
     RefreshObligation,
 
     // 8
@@ -302,8 +302,8 @@ pub enum LendingInstruction {
     ///   8. `[]` Flash loan receiver program id. Must implement an instruction
     ///      that has tag of 0 and a signature of `(amount: u64)` This
     ///      instruction must return the amount to the source liquidity account.
-    /// .. `[any]` Additional accounts expected by the receiving program's
-    /// `ReceiveFlashLoan` instruction.
+    ///   9. .. `[any]` Additional accounts expected by the receiving program's
+    ///      `ReceiveFlashLoan` instruction.
     ///
     ///   The flash loan receiver program that is to be invoked should contain
     /// an instruction with   tag `0` and accept the total amount (including
@@ -318,11 +318,11 @@ pub enum LendingInstruction {
     ///   1. `[writable]` Destination liquidity (matching the source from
     ///      above).
     ///   2. `[]` Token program id
-    ///   .. `[any]` Additional accounts provided to the lending program's
-    /// `FlashLoan` instruction above.   ReceiveFlashLoan {
-    ///       // Amount that must be repaid by the receiver program
-    ///       amount: u64
-    ///  }
+    ///   3. .. `[any]` Additional accounts provided to the lending program's
+    ///      `FlashLoan` instruction above.   ReceiveFlashLoan {
+    ///          // Amount that must be repaid by the receiver program
+    ///          amount: u64
+    ///      }
     FlashLoan {
         /// The amount that is to be borrowed - u64::MAX for up to 100% of
         /// available liquidity

token-lending/program/tests/helpers/flash_loan_receiver.rs

@@ -23,8 +23,8 @@ pub enum FlashLoanReceiverInstruction {
     ///   1. `[writable]` Destination liquidity (matching the source from
     ///      above).
     ///   2. `[]` Token program id
-    ///   .. `[any]` Additional accounts provided to the lending program's
-    /// `FlashLoan` instruction above.
+    ///   3. ..`[any]` Additional accounts provided to the lending program's
+    ///      `FlashLoan` instruction above.
     ReceiveFlashLoan {
         /// The amount that is loaned
         amount: u64,

token-metadata/interface/src/instruction.rs

@@ -104,10 +104,9 @@ pub enum TokenMetadataInstruction {
     /// By the end of the instruction, the metadata account must be properly
     /// resized based on the new size of the TLV entry.
     ///   * If the new size is larger, the program must first reallocate to
-    ///     avoid
-    ///   overwriting other TLV entries.
+    ///     avoid overwriting other TLV entries.
     ///   * If the new size is smaller, the program must reallocate at the end
-    ///   so that it's possible to iterate over TLV entries
+    ///     so that it's possible to iterate over TLV entries
     ///
     /// Accounts expected by this instruction:
     ///

token-swap/program/src/curve/offset.rs

@@ -33,9 +33,11 @@ pub struct OffsetCurve {
 impl CurveCalculator for OffsetCurve {
     /// Constant product swap ensures token a * (token b + offset) = constant
     /// This is guaranteed to work for all values such that:
+    ///
     ///  - 1 <= source_amount <= u64::MAX
     ///  - 1 <= (swap_source_amount * (swap_destination_amount +
     ///    token_b_offset)) <= u128::MAX
+    ///
     /// If the offset and token B are both close to u64::MAX, there can be
     /// overflow errors with the invariant.
     fn swap_without_fees(

token-swap/program/src/instruction.rs

@@ -108,9 +108,9 @@ pub enum SwapInstruction {
     ///   4. `[writable]` Pool Token Mint. Must be empty, owned by swap
     ///      authority.
     ///   5. `[]` Pool Token Account to deposit trading and withdraw fees.
-    ///   Must be empty, not owned by swap authority
+    ///      Must be empty, not owned by swap authority
     ///   6. `[writable]` Pool Token Account to deposit the initial pool token
-    ///   supply.  Must be empty, not owned by swap authority.
+    ///      supply. Must be empty, not owned by swap authority.
     ///   7. `[]` Pool Token program id
     Initialize(Initialize),
 

token-wrap/program/src/instruction.rs

@@ -45,8 +45,8 @@ pub enum TokenWrapInstruction {
     /// 6. `[]` SPL Token program for unwrapped mint
     /// 7. `[]` SPL Token program for wrapped mint
     /// 8. `[signer]` Transfer authority on unwrapped token account
-    /// 8..8+M. `[signer]` (Optional) M multisig signers on unwrapped token
-    /// account
+    /// 9. ..8+M. `[signer]` (Optional) M multisig signers on unwrapped token
+    ///    account
     ///
     /// Data expected by this instruction:
     ///   * little-endian u64 representing the amount to wrap
@@ -72,8 +72,8 @@ pub enum TokenWrapInstruction {
     /// 6. `[]` SPL Token program for wrapped mint
     /// 7. `[]` SPL Token program for unwrapped mint
     /// 8. `[signer]` Transfer authority on wrapped token account
-    /// 8..8+M. `[signer]` (Optional) M multisig signers on wrapped token
-    /// account
+    /// 9. ..8+M. `[signer]` (Optional) M multisig signers on wrapped token
+    ///    account
     ///
     /// Data expected by this instruction:
     ///   * little-endian u64 representing the amount to unwrap

token/program-2022/src/extension/confidential_transfer/instruction.rs

@@ -102,8 +102,8 @@ pub enum ConfidentialTransferInstruction {
     ///   3. `[]` (Optional) Record account if the accompanying proof is to be
     ///      read from a record account.
     ///   4. `[]` The multisig source account owner.
-    ///   5.. `[signer]` Required M signer accounts for the SPL Token Multisig
-    /// account.
+    ///   5. .. `[signer]` Required M signer accounts for the SPL Token Multisig
+    ///      account.
     ///
     /// Data expected by this instruction:
     ///   `ConfigureAccountInstructionData`
@@ -166,8 +166,8 @@ pub enum ConfidentialTransferInstruction {
     ///   2. `[]` (Optional) Record account if the accompanying proof is to be
     ///      read from a record account.
     ///   3. `[]` The multisig account owner.
-    ///   4.. `[signer]` Required M signer accounts for the SPL Token Multisig
-    /// account.
+    ///   4. .. `[signer]` Required M signer accounts for the SPL Token Multisig
+    ///      account.
     ///
     /// Data expected by this instruction:
     ///   `EmptyAccountInstructionData`
@@ -194,8 +194,8 @@ pub enum ConfidentialTransferInstruction {
     ///   0. `[writable]` The SPL Token account.
     ///   1. `[]` The token mint.
     ///   2. `[]` The multisig account owner or delegate.
-    ///   3.. `[signer]` Required M signer accounts for the SPL Token Multisig
-    /// account.
+    ///   3. .. `[signer]` Required M signer accounts for the SPL Token Multisig
+    ///      account.
     ///
     /// Data expected by this instruction:
     ///   `DepositInstructionData`
@@ -207,8 +207,10 @@ pub enum ConfidentialTransferInstruction {
     /// In order for this instruction to be successfully processed, it must be
     /// accompanied by the following list of `zk_elgamal_proof` program
     /// instructions:
+    ///
     /// - `VerifyCiphertextCommitmentEquality`
     /// - `VerifyBatchedRangeProofU64`
+    ///
     /// These instructions can be accompanied in the same transaction or can be
     /// pre-verified into a context state account, in which case, only their
     /// context state account address need to be provided.
@@ -241,8 +243,8 @@ pub enum ConfidentialTransferInstruction {
     ///   4. `[]` (Optional) Range proof record account or context state
     ///      account.
     ///   5. `[]` The multisig  source account owner.
-    ///   6.. `[signer]` Required M signer accounts for the SPL Token Multisig
-    /// account.
+    ///   6. .. `[signer]` Required M signer accounts for the SPL Token Multisig
+    ///      account.
     ///
     /// Data expected by this instruction:
     ///   `WithdrawInstructionData`
@@ -253,9 +255,11 @@ pub enum ConfidentialTransferInstruction {
     /// In order for this instruction to be successfully processed, it must be
     /// accompanied by the following list of `zk_elgamal_proof` program
     /// instructions:
+    ///
     /// - `VerifyCiphertextCommitmentEquality`
     /// - `VerifyBatchedGroupedCiphertext3HandlesValidity`
     /// - `VerifyBatchedRangeProofU128`
+    ///
     /// These instructions can be accompanied in the same transaction or can be
     /// pre-verified into a context state account, in which case, only their
     /// context state account addresses need to be provided.
@@ -291,8 +295,8 @@ pub enum ConfidentialTransferInstruction {
     ///   7. `[]` (Optional) Range proof record account or context state
     ///      account.
     ///   8. `[]` The multisig  source account owner.
-    ///   9.. `[signer]` Required M signer accounts for the SPL Token Multisig
-    /// account.
+    ///   9. .. `[signer]` Required M signer accounts for the SPL Token Multisig
+    ///      account.
     ///
     /// Data expected by this instruction:
     ///   `TransferInstructionData`
@@ -319,8 +323,8 @@ pub enum ConfidentialTransferInstruction {
     ///   * Multisignature owner/delegate
     ///   0. `[writable]` The SPL Token account.
     ///   1. `[]` The multisig account owner.
-    ///   2.. `[signer]` Required M signer accounts for the SPL Token Multisig
-    /// account.
+    ///   2. .. `[signer]` Required M signer accounts for the SPL Token Multisig
+    ///      account.
     ///
     /// Data expected by this instruction:
     ///   `ApplyPendingBalanceData`
@@ -338,8 +342,8 @@ pub enum ConfidentialTransferInstruction {
     ///   * Multisignature owner/delegate
     ///   0. `[writable]` The SPL Token account.
     ///   1. `[]` Multisig authority.
-    ///   2.. `[signer]` Required M signer accounts for the SPL Token Multisig
-    /// account.
+    ///   2. .. `[signer]` Required M signer accounts for the SPL Token Multisig
+    ///      account.
     ///
     /// Data expected by this instruction:
     ///   None
@@ -363,8 +367,8 @@ pub enum ConfidentialTransferInstruction {
     ///   * Multisignature owner/delegate
     ///   0. `[writable]` The SPL Token account.
     ///   1. `[]` The multisig account owner.
-    ///   2.. `[signer]` Required M signer accounts for the SPL Token Multisig
-    /// account.
+    ///   2. .. `[signer]` Required M signer accounts for the SPL Token Multisig
+    ///      account.
     ///
     /// Data expected by this instruction:
     ///   None
@@ -382,8 +386,8 @@ pub enum ConfidentialTransferInstruction {
     ///   * Multisignature owner/delegate
     ///   0. `[writable]` The SPL Token account.
     ///   1. `[]` The multisig account owner.
-    ///   2.. `[signer]` Required M signer accounts for the SPL Token Multisig
-    /// account.
+    ///   2. .. `[signer]` Required M signer accounts for the SPL Token Multisig
+    ///      account.
     ///
     /// Data expected by this instruction:
     ///   None
@@ -404,8 +408,8 @@ pub enum ConfidentialTransferInstruction {
     ///   * Multisignature owner/delegate
     ///   0. `[writable]` The SPL Token account.
     ///   1. `[]` The multisig account owner.
-    ///   2.. `[signer]` Required M signer accounts for the SPL Token Multisig
-    /// account.
+    ///   2. .. `[signer]` Required M signer accounts for the SPL Token Multisig
+    ///      account.
     ///
     /// Data expected by this instruction:
     ///   None
@@ -416,12 +420,14 @@ pub enum ConfidentialTransferInstruction {
     /// In order for this instruction to be successfully processed, it must be
     /// accompanied by the following list of `zk_elgamal_proof` program
     /// instructions:
+    ///
     /// - `VerifyCiphertextCommitmentEquality`
     /// - `VerifyBatchedGroupedCiphertext3HandlesValidity` (transfer amount
     ///   ciphertext)
     /// - `VerifyPercentageWithFee`
     /// - `VerifyBatchedGroupedCiphertext2HandlesValidity` (fee ciphertext)
     /// - `VerifyBatchedRangeProofU256`
+    ///
     /// These instructions can be accompanied in the same transaction or can be
     /// pre-verified into a context state account, in which case, only their
     /// context state account addresses need to be provided.
@@ -467,7 +473,7 @@ pub enum ConfidentialTransferInstruction {
     ///   9. `[]` (Optional) Range proof record account or context state
     ///      account.
     ///   10. `[]` The multisig  source account owner.
-    ///   11.. `[signer]` Required M signer accounts for the SPL Token Multisig
+    ///   11. .. `[signer]` Required M signer accounts for the SPL Token Multisig
     ///
     /// Data expected by this instruction:
     ///   `TransferWithFeeInstructionData`