Document caml_result in the manual (FFI chapter)#13216
Conversation
bf20db2 to
f341901
Compare
|
Thanks @dustanddreams and @dbuenzli, I took your comments into account. I also actually checked that the example compiles (not bad, I only wrote |
f341901 to
a54325e
Compare
NickBarnes
left a comment
There was a problem hiding this comment.
Looks good to me (apart from that one typo).
a54325e to
8fdffa8
Compare
gadmm
left a comment
There was a problem hiding this comment.
This looks good to me.
You could also add a link to the section ss:c-result in the last paragraph of the section ss:c-exceptions which mentions the caml_exception_* functions.
|
Shouldn't this get merged soon since #13013 has been? |
|
I would certainly be in favor and/but this requires the approval of a maintainer. (I also need to do another round on the feedback of @gadmm -- thanks! -- but this seems orthogonal to approval.) |
8fdffa8 to
058092d
Compare
|
Just approved.
I didn't merge yet because I noticed a discrepancy between the reviewers
mentionned in the commit andthose mentionned in theChanges entry. I
don'tmind but wated to give an opportunity forthisto be fixed, if you
wanted so, @gashce. Feel free to merge whenever you like as far asI am
concerned.
|
058092d to
b4a84df
Compare
|
Thanks @shindere! When I restarted working on this PR I had forgotten that it had its own Changes entry, so I used commit metadata (which I don't normally use) to credit reviewers. This is fixed now -- the Changes has all names, and I removed the Reviewed-by tag, nothing against them but they are not standard practice in OCaml land so there is little point in using them just once. |
This PR is a companion to #13013, providing documentation for the new
caml_resulttype and convention in the OCaml manual, FFI chapter.I mostly removed the documentation of the previous encoded-exceptions API, except for in-passing mentions that it may still be used for compatibility with pre-5.3 codebases. People who need to understand the encoded-exception API will have to look for older versions of the manual.