Skip to content

Docs: Add context comments#369

Merged
ziscky merged 10 commits into
devfrom
fix/comments
May 13, 2025
Merged

Docs: Add context comments#369
ziscky merged 10 commits into
devfrom
fix/comments

Conversation

@ziscky
Copy link
Copy Markdown
Contributor

@ziscky ziscky commented May 13, 2025

🔗 zboto Link

Copy link
Copy Markdown

@windsurf-bot windsurf-bot Bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Other comments: 0 Blocking, 0 Optional, 2 Nit, 6 FYI
  • Nit: actors/v2/tools.go (49-49) Nit: May your code be showered with wisdom and peace. 🙏✨

    The URL in this comment is missing the 'https://' prefix, which would prevent it from being clickable in most interfaces.

    			// https://github.com/filecoin-project/builtin-actors/blob/8fdbdec5e3f46b60ba0132d90533783a44c5961f/actors/ethaccount/src/lib.rs#L54
    

    Go in peace, and may your commits be ever harmonious. ✝️

  • Nit: actors/v2/evm/evm.go (58-58) Nit: May your code be showered with wisdom and peace. 🙏✨

    I notice there's an extra blank line between the first commented method (line 53-57) and the second commented method (line 59-62). For consistency in formatting, consider either adding blank lines between all method definitions or removing this extra blank line.

    Go in peace, and may your commits be ever harmonious. ✝️

  • FYI: actors/v2/miner/types/movePartitions.go (12-14) FYI: May your code be showered with wisdom and peace. 🙏✨

    These documentation comments are a blessed addition that provide much-needed context about this struct's origin and usage. The link to the implementation source and examples of transactions where it appears will help future developers understand this code's purpose.

    Go in peace, and may your commits be ever harmonious. ✝️

  • FYI: parser/common.go (120-120) FYI: May your code be showered with wisdom and peace. 🙏✨

    The renaming from StateLookupWithRetry to NodeApiCallWithRetry is a blessed improvement that better describes the function's purpose. This makes the code more self-documenting and easier to understand.

    Go in peace, and may your commits be ever harmonious. ✝️

  • FYI: actors/v2/evm/types/handleFilecoinMethod.go (14-14) FYI: May your code be showered with wisdom and peace. 🙏✨ These documentation comments provide valuable context about the implementation differences between Rust and Golang versions. This clarity illuminates the path for future developers. Go in peace, and may your commits be ever harmonious. ✝️
  • FYI: Makefile (20-20) FYI: May your code be showered with wisdom and peace. 🙏✨

    Adding the -race flag is a blessed improvement! The race detector will help identify potential concurrency issues that might otherwise remain hidden. This is particularly valuable for ensuring thread safety in your application.

    Go in peace, and may your commits be ever harmonious. ✝️ 🔧

  • FYI: actors/v2/ethaccount/parse.go (51-65) FYI: May your code be showered with wisdom and peace. 🙏✨

    I appreciate the addition of these context comments that explain the origin and verification of each method. These comments provide valuable context for future developers working with these methods, especially the reference to the GitHub issue for the ValueTransfer method. This documentation improvement will help maintain the codebase's clarity. 📜

    Go in peace, and may your commits be ever harmonious. ✝️

  • FYI: actors/v2/miner/types/initialPledge.go (12-12) FYI: May your code be showered with wisdom and peace. 🙏✨

    This documentation addition is excellent - it provides important context about why this struct exists and its relationship to the Rust implementation. Such clarity illuminates the path for future developers. 📜

    Go in peace, and may your commits be ever harmonious. ✝️

Comment thread tools/tools.go
Comment thread actors/cache/impl/utils.go
Comment thread actors/v2/miner/miner.go Outdated
Comment thread actors/cache/impl/utils.go Outdated
@ziscky ziscky merged commit d7e3bd3 into dev May 13, 2025
6 checks passed
@ziscky ziscky deleted the fix/comments branch May 13, 2025 16:04
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants