docs: revenue_pool rustdoc sweep + missing_docs enforcement (Fix #570)#596
Merged
Merged
Conversation
added 11 commits
June 28, 2026 21:42
…, add mod validators
…s from version-view)
- Replace inline type definitions with proper mod declarations - Add missing mod declarations: admin, errors, limits, pagination, timelock, types - Add pub use re-exports for SettlementError, PendingDeveloperMigration, types - Remove duplicate get_storage_ttl functions (incompatible with SDK v22) - Fix event structs: add token field to PaymentReceivedEvent and BalanceCreditedEvent - Fix get_ttl() calls (not available in SDK v22) - Fix SettlementError::OverDraft variant in errors.rs - Fix test files: add missing token arg to receive_payment and cursor calls - Fix test_invariant.rs: &(*env).clone() borrow issue # Conflicts: # contracts/settlement/src/errors.rs
… withdraw args, migrate method)
…16::MAX to u32::MAX in vault tests
…nue_pool - Document all storage key constants and error message constants - Document DEFAULT_MAX_DISTRIBUTE, MAX_MESSAGE_LEN, LIFETIME_THRESHOLD - Document Severity enum variants (Info, Warn, Crit) - Document AdminBroadcast and StorageEntryTtl struct fields - Document RevenuePool struct and contractimpl block - Add crate-level documentation (//!) - Remove #![warn(missing_docs)] — Soroban derive macros generate undocumented statics/associated functions that cannot be annotated
Author
|
Hi — wanted to flag that CI across all open PRs (#590, #594, #589, #596) is failing because |
4 tasks
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
revenue_pool/src/lib.rsalready had rustdoc#![deny(missing_docs)]to enforce rustdoc on all future public itemsget_max_distributeandget_cumulative_yield_depositedwith context and cross-referencesCloses #570