documentation: Initial doccumentation draft#17
Merged
obiwac merged 2 commits intoinobulles:mainfrom Dec 18, 2025
Merged
Conversation
obiwac
reviewed
Dec 17, 2025
Member
obiwac
left a comment
obiwac
left a comment
There was a problem hiding this comment.
These are already great!
Doesn't have to be in this PR, but it would also good to add explainer comments at the top of certain source files. E.g. an explainer on what PTMs are at the top of primitive_type_member.h, because this is not an obvious concept by name
obiwac
reviewed
Dec 18, 2025
obiwac
reviewed
Dec 18, 2025
Member
obiwac
left a comment
obiwac
left a comment
There was a problem hiding this comment.
ok i'm being super nitpicky here.
One general and extremely nitpicky style comment: in my opinion (and to be consistent with the rest of the codebase), I don't think comments should be wrapped. One can set wrapping in their editor if they want to see it wrapped. Just do put individual sentences (i.e. ending with a period) on their own lines, to follow how markdown documents are generally written
obiwac
approved these changes
Dec 18, 2025
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.
Still a WIP but its better than nothing.