Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

doc(node): Add doc comments to iota-network/state_sync mod #1645

Merged
merged 5 commits into from
Aug 13, 2024

Conversation

jkrvivian
Copy link
Contributor

@jkrvivian jkrvivian commented Aug 6, 2024

Description of change

Add comments and doc comments to state_sync mod in iota-network .

Links to any relevant issues

Part of #1555

Type of change

  • Documentation Fix

Change checklist

  • I have followed the contribution guidelines for this project
  • I have performed a self-review of my own code

@jkrvivian jkrvivian added the documentation Improvements or additions to documentation label Aug 6, 2024
@jkrvivian jkrvivian requested a review from a team as a code owner August 6, 2024 12:47
@jkrvivian jkrvivian force-pushed the core-node/iota-network-state-sync-comments branch 2 times, most recently from 0ec4bee to bd42baa Compare August 7, 2024 06:18
crates/iota-network/src/state_sync/mod.rs Outdated Show resolved Hide resolved
@jkrvivian jkrvivian force-pushed the core-node/iota-network-state-sync-comments branch from a7b2134 to d4de0ff Compare August 13, 2024 06:13
Copy link
Member

@samuel-rufi samuel-rufi left a comment

Choose a reason for hiding this comment

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

Great!

@muXxer muXxer merged commit d56a3e5 into develop Aug 13, 2024
33 of 35 checks passed
@muXxer muXxer deleted the core-node/iota-network-state-sync-comments branch August 13, 2024 17:48
bingyanglin pushed a commit that referenced this pull request Aug 19, 2024
* doc(node): Add doc comments to state_sync mod

* fix: Fix typo

* fix: Make comments in StateSyncMessage doc comments

* fix: Capitalize the first character in comments

---------

Co-authored-by: muXxer <[email protected]>
alexsporn pushed a commit that referenced this pull request Sep 6, 2024
* doc(node): Add doc comments to state_sync mod

* fix: Fix typo

* fix: Make comments in StateSyncMessage doc comments

* fix: Capitalize the first character in comments

---------

Co-authored-by: muXxer <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants