0
0
Fork 0
mirror of https://github.com/denoland/rusty_v8.git synced 2024-12-25 16:49:29 -05:00

Fix busted doc comment (#1392)

* Fix busted doc comment

This doc comment contains raw HTML, when it's supposed
to contain generics. Fix this by wrapping them as code.

* Update src/handle.rs

---------

Co-authored-by: Matt Mastracci <matthew@mastracci.com>
This commit is contained in:
Michael Howell 2024-02-03 10:44:27 -07:00 committed by GitHub
parent d719d4b171
commit 54e93385b8
No known key found for this signature in database
GPG key ID: B5690EEEBB952194

View file

@ -62,14 +62,14 @@ extern "C" {
/// longer used.
///
/// It is safe to extract the object stored in the handle by
/// dereferencing the handle (for instance, to extract the *Object from
/// a Local<Object>); the value will still be governed by a handle
/// dereferencing the handle (for instance, to extract the `*Object` from
/// a `Local<Object>`); the value will still be governed by a handle
/// behind the scenes and the same rules apply to these values as to
/// their handles.
///
/// Note: Local handles in Rusty V8 differ from the V8 C++ API in that they are
/// never empty. In situations where empty handles are needed, use
/// Option<Local>.
/// `Option<Local>`.
#[repr(C)]
#[derive(Debug)]
pub struct Local<'s, T>(NonNull<T>, PhantomData<&'s ()>);