chore: document public APIs (part 1) #1776
Merged
Conversation
This file contains 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
josxha
force-pushed
the
document-public-apis
branch
from
990e431
to
783038b
Compare
josxha
force-pushed
the
document-public-apis
branch
3 times, most recently
from
b1b5544
to
189173f
Compare
josxha
changed the title
josxha
requested review from
ibrierley,
mootw,
TesteurManiak and
JaffaKetchup
josxha
force-pushed
the
document-public-apis
branch
from
6236e06
to
8ca685d
Compare
38 tasks
JaffaKetchup
approved these changes
Jan 21, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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 work in progress to document public APIs.
A lot of documentation has been added (master is currently on 603 undocumented members, this pull request crunches this number down to 85).
Marking this pull request as ready to review now because it feels like chasing a moving target with this pr.
If any reviewer has additions or wants to have some things changed, please commit directly to the branch if possible. There are documenations that could probably provide more details. The focus for this pull request was a bit more on quantity than on completeness.