refactor: add doc comments, move code around, rename#3977
Merged
Conversation
I can't work with obscure names that seem obvious to the persons writing them, so add doc comments explaining how things works. The RemoteStateActor did get a bit messy from all the changes. Make functions follow the naming conventions again, move them to their more logically grouped places and rename and document for clarity. Finally netmon, netwatch etc are all just meaningless names to me. Even after all this time. Name the variables and fields after the information they actually contain. This is all noise from #3928 that I'm splitting off so that that PR can contain just the relevant changes (and is easier to rebase/merge main).
|
Documentation for this PR has been generated and is available at: https://n0-computer.github.io/iroh/pr/3977/docs/iroh/ Last updated: 2026-02-26T15:53:29Z |
matheus23
approved these changes
Feb 26, 2026
Member
matheus23
left a comment
There was a problem hiding this comment.
Looks good besides some typos.
Member
|
One more missed typo in the codespell CI check ✌️ |
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.
Description
I can't work with obscure names that seem obvious to the persons
writing them, so add doc comments explaining how things works.
The RemoteStateActor did get a bit messy from all the changes. Make
functions follow the naming conventions again, move them to their more
logically grouped places and rename and document for clarity.
Finally netmon, netwatch etc are all just meaningless names to
me. Even after all this time. Name the variables and fields after the
information they actually contain.
Breaking Changes
n/a
Notes & open questions
This is all noise from #3928 that I'm splitting off so that that PR
can contain just the relevant changes (and is easier to rebase/merge
main).
Change checklist