docs: update some docstrings and readme structure#55
Merged
Saransh-cpp merged 12 commits intomainfrom Dec 11, 2025
Merged
Conversation
Saransh-cpp
force-pushed
the
saransh/more-docs
branch
from
4b01e73 to
cf1483f
Compare
Collaborator
|
Hey @Saransh-cpp I finished my part of README.md, I'd say lets merge and then we try some final executions from final main |
andreasaporito
approved these changes
Dec 11, 2025
Saransh-cpp
commented
Dec 11, 2025
Owner
Author
Saransh-cpp
left a comment
Saransh-cpp
left a comment
There was a problem hiding this comment.
@andreasaporito please take a look at the comments below and feel free to update/change them accordingly (or let me know if I made a mistake somewhere). Should be ready to merge after this!
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.
Closes #32
Closes #31
TODO: