Update generated docs

Author: tzakian

crates/sui-framework/docs/std/internal.md

@@ -12,8 +12,8 @@ module example::use_permit;
 public struct MyType { /* ... */ }
 
 public fun test_permit() {
-let permit = internal::permit<MyType>();
-/* external_module::call_with_permit(permit); */
+   let permit = internal::permit<MyType>();
+   /* external_module::call_with_permit(permit); */
 }
 ```
 
@@ -25,7 +25,7 @@ To write a function that is guarded by a <code><a href="../std/internal.md#std_i
 module example::type_registry;
 
 public fun register_type<T>(_: internal::Permit<T> /* ... */) {
-/* ... */
+  /* ... */
 }
 ```
 

crates/sui-framework/docs/sui/bcs.md

@@ -19,18 +19,18 @@ Usage example:
 /// This function reads u8 and u64 value from the input
 /// and returns the rest of the bytes.
 fun deserialize(bytes: vector<u8>): (u8, u64, vector<u8>) {
-use sui::bcs::{Self, BCS};
+    use sui::bcs::{Self, BCS};
 
-let prepared: BCS = bcs::new(bytes);
-let (u8_value, u64_value) = (
-prepared.peel_u8(),
-prepared.peel_u64()
-);
+    let prepared: BCS = bcs::new(bytes);
+    let (u8_value, u64_value) = (
+        prepared.peel_u8(),
+        prepared.peel_u64()
+    );
 
-// unpack bcs struct
-let leftovers = prepared.into_remainder_bytes();
+    // unpack bcs struct
+    let leftovers = prepared.into_remainder_bytes();
 
-(u8_value, u64_value, leftovers)
+    (u8_value, u64_value, leftovers)
 }
 ```
 
@@ -768,11 +768,11 @@ however the tag can be any <code>u32</code> value.
 Example:
 ```rust
 let my_enum = match (bcs.peel_enum_tag()) {
-0 => Enum::Empty,
-1 => Enum::U8(bcs.peel_u8()),
-2 => Enum::U16(bcs.peel_u16()),
-3 => Enum::Struct { a: bcs.peel_address(), b: bcs.peel_u8() },
-_ => abort,
+   0 => Enum::Empty,
+   1 => Enum::U8(bcs.peel_u8()),
+   2 => Enum::U16(bcs.peel_u16()),
+   3 => Enum::Struct { a: bcs.peel_address(), b: bcs.peel_u8() },
+   _ => abort,
 };
 ```
 

crates/sui-framework/docs/sui/display.md

@@ -74,11 +74,11 @@ on the property values of an Object.
 ```
 // Example of a display object
 Display<0x...::capy::Capy> {
-fields:
-<name, "Capy { genes }">
-<link, "https://capy.art/capy/{ id }">
-<image, "https://api.capy.art/capy/{ id }/svg">
-<description, "Lovely Capy, one of many">
+ fields:
+   <name, "Capy { genes }">
+   <link, "https://capy.art/capy/{ id }">
+   <image, "https://api.capy.art/capy/{ id }/svg">
+   <description, "Lovely Capy, one of many">
 }
 ```
 

crates/sui-framework/docs/sui/event.md

@@ -7,24 +7,24 @@ creates and sends a custom MoveEvent as a part of the effects
 certificate of the transaction.
 
 Every MoveEvent has the following properties:
-- sender
-- type signature (<code>T</code>)
-- event data (the value of <code>T</code>)
-- timestamp (local to a node)
-- transaction digest
+ - sender
+ - type signature (<code>T</code>)
+ - event data (the value of <code>T</code>)
+ - timestamp (local to a node)
+ - transaction digest
 
 Example:
 ```
 module my::marketplace {
-use sui::event;
-/* ... */
-struct ItemPurchased has copy, drop {
-item_id: ID, buyer: address
-}
-entry fun buy(/* .... */) {
-/* ... */
-event::emit(ItemPurchased { item_id: ..., buyer: .... })
-}
+   use sui::event;
+   /* ... */
+   struct ItemPurchased has copy, drop {
+     item_id: ID, buyer: address
+   }
+   entry fun buy(/* .... */) {
+      /* ... */
+      event::emit(ItemPurchased { item_id: ..., buyer: .... })
+   }
 }
 ```
 

crates/sui-framework/docs/sui/package.md

@@ -704,13 +704,13 @@ package.  This ticket only authorizes an upgrade to a package
 that matches this digest.  A package's contents are identified
 by two things:
 
-- modules: [[u8]]       a list of the package's module contents
-- deps:    [[u8; 32]]   a list of 32 byte ObjectIDs of the
-package's transitive dependencies
+ - modules: [[u8]]       a list of the package's module contents
+ - deps:    [[u8; 32]]   a list of 32 byte ObjectIDs of the
+                         package's transitive dependencies
 
 A package's digest is calculated as:
 
-sha3_256(sort(modules ++ deps))
+  sha3_256(sort(modules ++ deps))
 
 
 <pre><code><b>public</b> <b>fun</b> <a href="../sui/package.md#sui_package_ticket_digest">ticket_digest</a>(ticket: &<a href="../sui/package.md#sui_package_UpgradeTicket">sui::package::UpgradeTicket</a>): &vector&lt;u8&gt;

crates/sui-framework/docs/sui/protocol_config.md

@@ -33,8 +33,8 @@ We should never need to expose this to user packages.
 ### Arguments
 
 * <code>feature_flag_name</code> - The name of the feature flag as bytes (e.g., b"enable_vdf")
-- It is expected to be a valid UTF-8 string
-- The flag should exist in the protocol config
+  - It is expected to be a valid UTF-8 string
+  - The flag should exist in the protocol config
 
 
 <a name="@Returns_1"></a>
@@ -53,7 +53,7 @@ We should never need to expose this to user packages.
 use sui::protocol_config;
 
 if (protocol_config::is_feature_enabled(b"enable_accumulators")) {
-// Accumulators are available
+    // Accumulators are available
 };
 ```
 

crates/sui-framework/docs/sui_system/staking_pool.md

@@ -1099,12 +1099,12 @@ Called at epoch boundaries to process the pending stake.
 ## Function `withdraw_rewards`
 
 This function does the following:
-1. Calculates the total amount of SUI (including principal and rewards) that the provided pool tokens represent
-at the current exchange rate.
-2. Using the above number and the given <code>principal_withdraw_amount</code>, calculates the rewards portion of the
-stake we should withdraw.
-3. Withdraws the rewards portion from the rewards pool at the current exchange rate. We only withdraw the rewards
-portion because the principal portion was already taken out of the staker's self custodied StakedSui.
+    1. Calculates the total amount of SUI (including principal and rewards) that the provided pool tokens represent
+       at the current exchange rate.
+    2. Using the above number and the given <code>principal_withdraw_amount</code>, calculates the rewards portion of the
+       stake we should withdraw.
+    3. Withdraws the rewards portion from the rewards pool at the current exchange rate. We only withdraw the rewards
+       portion because the principal portion was already taken out of the staker's self custodied StakedSui.
 
 
 <pre><code><b>fun</b> <a href="../sui_system/staking_pool.md#sui_system_staking_pool_withdraw_rewards">withdraw_rewards</a>(pool: &<b>mut</b> <a href="../sui_system/staking_pool.md#sui_system_staking_pool_StakingPool">sui_system::staking_pool::StakingPool</a>, principal_withdraw_amount: u64, pool_token_withdraw_amount: u64, epoch: u64): <a href="../sui/balance.md#sui_balance_Balance">sui::balance::Balance</a>&lt;<a href="../sui/sui.md#sui_sui_SUI">sui::sui::SUI</a>&gt;

crates/sui-framework/docs/sui_system/storage_fund.md

@@ -56,12 +56,12 @@ title: Module `sui_system::storage_fund`
 
 Struct representing the storage fund, containing two <code>Balance</code>s:
 - <code><a href="../sui_system/storage_fund.md#sui_system_storage_fund_total_object_storage_rebates">total_object_storage_rebates</a></code> has the invariant that it's the sum of <code>storage_rebate</code> of
-all objects currently stored on-chain. To maintain this invariant, the only inflow of this
-balance is storage charges collected from transactions, and the only outflow is storage rebates
-of transactions, including both the portion refunded to the transaction senders as well as
-the non-refundable portion taken out and put into <code>non_refundable_balance</code>.
+   all objects currently stored on-chain. To maintain this invariant, the only inflow of this
+   balance is storage charges collected from transactions, and the only outflow is storage rebates
+   of transactions, including both the portion refunded to the transaction senders as well as
+   the non-refundable portion taken out and put into <code>non_refundable_balance</code>.
 - <code>non_refundable_balance</code> contains any remaining inflow of the storage fund that should not
-be taken out of the fund.
+   be taken out of the fund.
 
 
 <pre><code><b>public</b> <b>struct</b> <a href="../sui_system/storage_fund.md#sui_system_storage_fund_StorageFund">StorageFund</a> <b>has</b> store

crates/sui-framework/docs/sui_system/sui_system.md

@@ -15,9 +15,9 @@ To properly upgrade the <code>SuiSystemStateInner</code> type, we need to ship a
 1. Define a new <code>SuiSystemStateInner</code>type (e.g. <code>SuiSystemStateInnerV2</code>).
 2. Define a data migration function that migrates the old <code>SuiSystemStateInner</code> to the new one (i.e. SuiSystemStateInnerV2).
 3. Replace all uses of <code>SuiSystemStateInner</code> with <code>SuiSystemStateInnerV2</code> in both sui_system.move and sui_system_state_inner.move,
-with the exception of the <code><a href="../sui_system/sui_system_state_inner.md#sui_system_sui_system_state_inner_create">sui_system_state_inner::create</a></code> function, which should always return the genesis type.
+   with the exception of the <code><a href="../sui_system/sui_system_state_inner.md#sui_system_sui_system_state_inner_create">sui_system_state_inner::create</a></code> function, which should always return the genesis type.
 4. Inside <code><a href="../sui_system/sui_system.md#sui_system_sui_system_load_inner_maybe_upgrade">load_inner_maybe_upgrade</a></code> function, check the current version in the wrapper, and if it's not the latest version,
-call the data migration function to upgrade the inner object. Make sure to also update the version in the wrapper.
+  call the data migration function to upgrade the inner object. Make sure to also update the version in the wrapper.
 A detailed example can be found in sui/tests/framework_upgrades/mock_sui_systems/shallow_upgrade.
 Along with the Move change, we also need to update the Rust code to support the new type. This includes:
 1. Define a new <code>SuiSystemStateInner</code> struct type that matches the new Move type, and implement the SuiSystemStateTrait.
@@ -32,7 +32,7 @@ To upgrade Validator type, besides everything above, we also need to:
 2. Define a data migration function that migrates the old Validator to the new one (i.e. ValidatorV2).
 3. Replace all uses of Validator with ValidatorV2 except the genesis creation function.
 4. In validator_wrapper::upgrade_to_latest, check the current version in the wrapper, and if it's not the latest version,
-call the data migration function to upgrade it.
+ call the data migration function to upgrade it.
 In Rust, we also need to add a new case in <code>get_validator_from_table</code>.
 Note that it is possible to upgrade SuiSystemStateInner without upgrading Validator, but not the other way around.
 And when we only upgrade SuiSystemStateInner, the version of Validator in the wrapper will not be updated, and hence may become
@@ -1556,7 +1556,7 @@ This function should be called at the end of an epoch, and advances the system t
 It does the following things:
 1. Add storage charge to the storage fund.
 2. Burn the storage rebates from the storage fund. These are already refunded to transaction sender's
-gas coins.
+   gas coins.
 3. Distribute computation charge to validator stake.
 4. Update all validators.
 

crates/sui-framework/docs/sui_system/sui_system_state_inner.md

@@ -2202,7 +2202,7 @@ This function should be called at the end of an epoch, and advances the system t
 It does the following things:
 1. Add storage charge to the storage fund.
 2. Burn the storage rebates from the storage fund. These are already refunded to transaction sender's
-gas coins.
+   gas coins.
 3. Distribute computation charge to validator stake.
 4. Update all validators.