Skip to content

Commit 6cdc074

Browse files
fix: resolve rustdoc warnings breaking CI documentation check
- Remove doc-link to private const `MAX_SOURCE_SIZE` in move_parser.rs - Fix unresolved doc-links to `Display` and `to_string()` in error.rs Co-authored-by: Cursor <cursoragent@cursor.com>
1 parent a1b2978 commit 6cdc074

File tree

2 files changed

+4
-4
lines changed

2 files changed

+4
-4
lines changed

crates/aptos-sdk/src/codegen/move_parser.rs

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -60,8 +60,8 @@ impl MoveSourceParser {
6060
///
6161
/// # Security
6262
///
63-
/// Returns an empty `MoveModuleInfo` if the source exceeds [`MAX_SOURCE_SIZE`]
64-
/// to prevent memory exhaustion from extremely large inputs.
63+
/// Returns an empty `MoveModuleInfo` if the source exceeds `MAX_SOURCE_SIZE`
64+
/// (10 MB) to prevent memory exhaustion from extremely large inputs.
6565
pub fn parse(source: &str) -> MoveModuleInfo {
6666
if source.len() > MAX_SOURCE_SIZE {
6767
return MoveModuleInfo::default();

crates/aptos-sdk/src/error.rs

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -16,10 +16,10 @@ pub type AptosResult<T> = Result<T, AptosError>;
1616
///
1717
/// # Security: Logging Errors
1818
///
19-
/// **WARNING:** The [`Display`] implementation on this type may include sensitive
19+
/// **WARNING:** The `Display` implementation on this type may include sensitive
2020
/// information (e.g., partial key material, JWT tokens, or mnemonic phrases) in
2121
/// its output. When logging errors, always use [`sanitized_message()`](AptosError::sanitized_message)
22-
/// instead of [`to_string()`] or [`Display`]:
22+
/// instead of `to_string()` or `Display`:
2323
///
2424
/// ```rust,ignore
2525
/// // WRONG - may leak sensitive data:

0 commit comments

Comments
 (0)