Uh oh!
There was an error while loading. Please reload this page.
Document stubs - #13677
Conversation
Uh oh!
There was an error while loading. Please reload this page.
c6c16d2 to
90b2a67Compare
iluuu1994
left a comment
There was a problem hiding this comment.
Thank you! I did read this in detail. There are some grammatical oddities, but I'm not sure code reviews are a good tool to fix those.
Please check the README on how to auto-format the files.
Thank you for providing some documentation on the frameless calls 🙂
There was a problem hiding this comment.
I think you should start out explaining what problem stubs solve exactly, along with maybe a simple example of a stub and a function implementation.
There was a problem hiding this comment.
I'll try to come up with a better intro.. I also felt that the current one is not very good :D
Uh oh!
There was an error while loading. Please reload this page.
There was a problem hiding this comment.
Mostly, it is about not creating a stack frame, but passing arguments to the function directly via the ICALL operands. Hence the name "frameless".
kocsismate
commented
Mar 14, 2024
Feel free to point these out/suggest a better wording, and I'll try to fix them! I wouldn't want to provide docs which scares native speakers. |
Girgias
left a comment
There was a problem hiding this comment.
Mostly looks good just some nits
Uh oh!
There was an error while loading. Please reload this page.
Uh oh!
There was an error while loading. Please reload this page.
Uh oh!
There was an error while loading. Please reload this page.
Uh oh!
There was an error while loading. Please reload this page.
Uh oh!
There was an error while loading. Please reload this page.
Uh oh!
There was an error while loading. Please reload this page.
derickr
commented
Mar 18, 2024
I could do quite a bit to make this easier to read — but would it make sense if I spend an hour on it? |
kocsismate
commented
Apr 12, 2024
@derickr just a gentle ping: will you have capacity on improving the wording in the near future? |
Edit for clarity, add some examples, and use foo/bar less
kocsismate
commented
May 27, 2024
With the help of Derick, the documentation was revamped :) |
kocsismate
commented
May 29, 2024
@iluuu1994 If you have followup suggestions, or anything comes to your mind which should be improved, feel free to reach out to me! |
kocsismate
commented
May 29, 2024
The documentation is now live at https://php.github.io/php-src/miscellaneous/stubs.html |
I'm not a good writer, so feel free to suggest better wording/rephrase the text wherever needed :)