chore: fix stale doc comments#1

Open

simone-stacks wants to merge 102 commits into

developfrom

chore/fix-stale-comments

Commits on May 15, 2026

doc: remove stale NotInPreparePhase claim on get_nakamoto_reward_cycle_info

stale-comment-agent
authored and
simone-stacks
committed
doc: remove stale 'invalid slot' error claim on get_miner_slot

stale-comment-agent
authored and
simone-stacks
committed
doc: correct bind() comment to reflect panic-on-failure behavior

stale-comment-agent
authored and
simone-stacks
committed
doc: correct LeaderBlockCommitOp::check return claim

stale-comment-agent
authored and
simone-stacks
committed
doc: correct increase_lock_v{2,3,4} panic/version claims

stale-comment-agent
authored and
simone-stacks
committed
doc: correct main_loop comment about run_one_pass return value

stale-comment-agent
authored and
simone-stacks
committed
doc: correct make_block_commit return-on-failure claim

stale-comment-agent
authored and
simone-stacks
committed
doc: correct canonical_repr_at_block to reflect enum STXBalance

stale-comment-agent
authored and
simone-stacks
committed
doc: get_block_processed_and_signed_weight does not filter on orphaned

stale-comment-agent
authored and
simone-stacks
committed
doc: process_new_anchored_block returns BlockAcceptResponse not bool

stale-comment-agent
authored and
simone-stacks
committed
doc: process_new_nakamoto_block_ext returns BlockAcceptResponse not bool

stale-comment-agent
authored and
simone-stacks
committed
doc: preprocess_anchored_block refers to non-existent SortitionDB::expects_stacks_block

stale-comment-agent
authored and
simone-stacks
committed
doc: as_block_rejection doc says 'block accept' but extracts rejection

stale-comment-agent
authored and
simone-stacks
committed
doc: rotate_vrf_and_register doc claims bool return but function returns ()

stale-comment-agent
authored and
simone-stacks
committed
doc: process_new_nakamoto_block refers to non-existent inner_process_new_nakamoto_block

stale-comment-agent
authored and
simone-stacks
committed
doc: total_signing_weight returns Result<u32, String> not ChainstateError

stale-comment-agent
authored and
simone-stacks
committed
doc: MARF::seal returns Err on already-sealed, does not panic

stale-comment-agent
authored and
simone-stacks
committed
doc: extend_trie returns Result<(), Error> not bool

stale-comment-agent
authored and
simone-stacks
committed
doc: from_parent_unsigned returns Option, not an error type

stale-comment-agent
authored and
simone-stacks
committed
doc: process_block_ops returns tuple, doc claimed only BlockSnapshot

stale-comment-agent
authored and
simone-stacks
committed
doc: net/api new_get* helpers were copy-pasted from getinfo.rs

stale-comment-agent
authored and
simone-stacks
committed
tmp: pox v4 doc fix

swarm
authored and
simone-stacks
committed
tmp: set_block_processed/orphaned attachable doc

swarm
authored and
simone-stacks
committed
tmp: get_nakamoto_blocks_in_tenure doc

swarm
authored and
simone-stacks
committed
tmp: check_first_nakamoto_tenure_change

swarm
authored and
simone-stacks
committed
tmp: clarity special_get info doc fix

swarm
authored and
simone-stacks
committed
tmp: BlockAccepted struct doc

swarm
authored and
simone-stacks
committed
tmp: MockProposal::new doc

swarm
authored and
simone-stacks
committed
tmp: BlockResponseData::new doc

swarm
authored and
simone-stacks
committed
tmp: pre_epoch_begin doc

swarm
authored and
simone-stacks
committed
tmp: build_anchored_block doc

swarm
authored and
simone-stacks
committed
tmp: sign_next* docs

swarm
authored and
simone-stacks
committed
tmp: get_consensus_at doc

swarm
authored and
simone-stacks
committed
tmp: get_coinbase_tx doc

swarm
authored and
simone-stacks
committed
tmp: find_mature_miner_rewards doc

swarm
authored and
simone-stacks
committed
tmp: get_nakamoto_block_status doc

swarm
authored and
simone-stacks
committed
tmp: pox-locking pox4 docs

swarm
authored and
simone-stacks
committed
tmp: send_next_download_request doc

swarm
authored and
simone-stacks
committed
tmp: ReplayScopeOpt doc

stale-comment-agent
authored and
simone-stacks
committed
tmp: make_min_median_distribution doc user-burns

stale-comment-agent
authored and
simone-stacks
committed
tmp: capitulate_miner_view doc local_address

stale-comment-agent
authored and
simone-stacks
committed
tmp: ATC_LOOKUP doc above->below

stale-comment-agent
authored and
simone-stacks
committed
tmp: put_data_with_size doc

stale-comment-agent
authored and
simone-stacks
committed
tmp: NakamotoBlockBuilder::new doc params

stale-comment-agent
authored and
simone-stacks
committed
tmp: check_shadow_coinbase_tx doc

stale-comment-agent
authored and
simone-stacks
committed
tmp: shadow_load_tenure_info doc

stale-comment-agent
authored and
simone-stacks
committed
tmp: validate_shadow_against_burnchain doc burn_tip

stale-comment-agent
authored and
simone-stacks
committed
tmp: get_shadow_vrf_proof doc

stale-comment-agent
authored and
simone-stacks
committed
tmp: get_matured_miner_reward_schedules doc

stale-comment-agent
authored and
simone-stacks
committed
tmp: PREAMBLE_ENCODED_SIZE doc fields above

stale-comment-agent
authored and
simone-stacks
committed
tmp: BlockMetadata.tenure_size doc

stale-comment-agent
authored and
simone-stacks
committed
tmp: MerkleTree::path empty-tree doc

stale-comment-agent
authored and
simone-stacks
committed
tmp: check_valid_consensus_hash doc

stale-comment-agent
authored and
simone-stacks
committed
tmp: handle_insert_block_error doc

stale-comment-agent
authored and
simone-stacks
committed
tmp: SignerDb::new doc

stale-comment-agent
authored and
simone-stacks
committed
tmp: is_preamble_valid doc

stale-comment-agent
authored and
simone-stacks
committed
tmp: highest_reward_cycle doc

stale-comment-agent
authored and
simone-stacks
committed
tmp: make_chunk_request_schedule doc

stale-comment-agent
authored and
simone-stacks
committed
tmp: update_from_handshake_data doc

stale-comment-agent
authored and
simone-stacks
committed
tmp: process_getnakamotoinv_finishes doc

stale-comment-agent
authored and
simone-stacks
committed
tmp: insert_block doc broadcast column

stale-comment-agent
authored and
simone-stacks
committed
tmp: commit_metadata_for_trie doc drop sibling fn name

stale-comment-agent
authored and
simone-stacks
committed
tmp: handle_signer_stackerdb_update doc reward_cycle

stale-comment-agent
authored and
simone-stacks
committed
stale-comment: address_testnet doc says mainnet

swarm
authored and
simone-stacks
committed
stale-comment: try_replace_chunk doc lists only StaleChunk

swarm
authored and
simone-stacks
committed
stale-comment: finished_tenure_consensus_hash maps to bool not block ID

swarm
authored and
simone-stacks
committed
stale-comment: get_nakamoto_tenure_length doc misrepresents return value

swarm
authored and
simone-stacks
committed
stale-comment: decode_http_request doc says tuple, returns struct

swarm
authored and
simone-stacks
committed
stale-comment: make_next_download_request doc lists nonexistent Ok(None)

swarm
authored and
simone-stacks
committed
stale-comment: get_current_burnchain_block_height doc only describes pre-3.0 path

swarm
authored and
simone-stacks
committed
stale-comment: walk_peer_graph doc reverses tuple order

swarm
authored and
simone-stacks
committed
stale-comment: get_db_version_from_path doc says string; returns u32

swarm
authored and
simone-stacks
committed
stale-comment: SignerEntries::parse doc names nonexistent type NakamotoSignEntry

swarm
authored and
simone-stacks
committed
stale-comment: store_burnchain_db_entry doc claims row ID; returns ()

swarm
authored and
simone-stacks
committed
stale-comment: SortitionHash::initial doc describes mix_burn_header

swarm
authored and
simone-stacks
committed
stale-comment: finish_block doc omits SIP-031 event from FinishBlockEvents

swarm
authored and
simone-stacks
committed
stale-comment: get_block_cost doc says 'of block' but queries total_tenure_cost

swarm
authored and
simone-stacks
committed
stale-comment: get_tx_info_from_txid doc lists 2 of 3 returned values

swarm
authored and
simone-stacks
committed
stale-comment: decode_http_response doc has tuple order reversed

swarm
authored and
simone-stacks
committed
stale-comment: add_block_rejection_signer_addr doc says signature

swarm
authored and
simone-stacks
committed
stale-comment: append_block doc omits Option<RewardSetData>

swarm
authored and
simone-stacks
committed
doc: BlockProposalData::new mentions miner_diagnostic_data, not unknown_bytes

quality-swarm
authored and
simone-stacks
committed
doc: handle_comms_epoch2 takes bits, not comms

quality-swarm
authored and
simone-stacks
committed
doc: handle_new_nakamoto_stacks_block always returns Ok(None) on success

quality-swarm
authored and
simone-stacks
committed
doc: handle_pox_cycle_start_pox_4 is a no-op

quality-swarm
authored and
simone-stacks
committed
doc: relay_epoch3_blocks uses recently_sent map, not force_send param

quality-swarm
authored and
simone-stacks
committed
doc: effective_unlock_height mentions PoX 4 early unlock for PoX 3

quality-swarm
authored and
simone-stacks
committed
doc: tx_busy_handler never panics; describes actual behaviour

quality-swarm
authored and
simone-stacks
committed
doc: inner_execute_contract refers to ExecutionState, not Environment

quality-swarm
authored and
simone-stacks
committed
quality: 018 process-stx-unlocks-tuple-doc

quality-swarm
authored and
simone-stacks
committed
quality: 019 setup-block-doc-omits-six-fields

quality-swarm
authored and
simone-stacks
committed
quality: 020 process-microblocks-transactions-doc-omits-receipts

quality-swarm
authored and
simone-stacks
committed
quality: 021 process-block-transactions-doc-omits-receipts

quality-swarm
authored and
simone-stacks
committed
doc: fix burn-block-info property identifiers in special_get_burn_block_info

quality-agent
authored and
simone-stacks
committed
fix doc comment for EarlyReturnError::UnwrapFailed

quality-bot
authored and
simone-stacks
committed
fix LruCache::flush doc to match flattened Result type

quality-bot
authored and
simone-stacks
committed
fix get_reward_set doc to match return type

quality-bot
authored and
simone-stacks
committed
fix verify_signer_signatures doc to include NoRegisteredSigners

quality-bot
authored and
simone-stacks
committed
fix get_read_count_extend_timestamp doc: copy-paste from tenure-extend

quality-bot
authored and
simone-stacks
committed
fix check_burnchain_config_changed doc: actual return tuple, unconditional updates

quality-bot
authored and
simone-stacks
committed
docs: pox-locking pox_lock_extend/increase docs use LockingError, not Error

quality-bot
authored and
simone-stacks
committed
docs: static_check_problematic_relayed_tx returns Result<(), Error>, not bool

quality-bot
authored and
simone-stacks
committed