docs: add explanatory comments to main function#2350
Open
dandiest wants to merge 1 commit intorust-lang:mainfrom
Open
docs: add explanatory comments to main function#2350dandiest wants to merge 1 commit intorust-lang:mainfrom
dandiest wants to merge 1 commit intorust-lang:mainfrom
Conversation
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
1 participant
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
This PR adds descriptive comments to the
mainfunction insrc/main.rs.Why this is needed
Currently, the
mainfunction lacks documentation. Adding these comments helps new contributors and students understand the application's startup flow, specifically:Checklist
cargo checkand it passes.cargo fmtto ensure correct formatting.