Cargo style documentation for developper#308
Open
slcorrensi wants to merge 5 commits intoCyberTimon:mainfrom
Open
Cargo style documentation for developper#308slcorrensi wants to merge 5 commits intoCyberTimon:mainfrom
slcorrensi wants to merge 5 commits intoCyberTimon:mainfrom
Conversation
Owner
|
Thanks for putting this together! I’d prefer not to merge it right now though, since I find comments slow me down in development a lot (as I use a lot of AI to code). Maybe we can revisit a different approach to docs later on. What do you think? |
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.
This is a beginning of code comments to create cargo style documentation for the backend. It would allow easier dive into the project for newcomers. Not all the files are yet commented (especially ai_processing.rs, comfyui_connector.rs and file_management.rs). Some function explanations are not the best yet but this is a start.