Add docs for the meta and function_patching APIs #66
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
Also fixed some information being in the wrong place, clarified some other information, etc.
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.
My descriptions are mostly based on either comments already in the code, or what I could gather from either what the function does or where it has been used in existing plugins. Feel free to edit my descriptions to something better, I'm probably nowhere near the best source for summarizing what the code is doing.
I was thinking it may be better to go through and copy-paste the descriptions from libfunctionpatcher, though I have not actually gone through and done that because I only recently discovered that that has its own repo, and then to that extent I haven't actually compared
libfunctionpatcherwithlibwups' function patching API to see what differences there are, if any.Also, my commit titles are not particularly descriptive, sorry in advance-