Skip to content

Commit

Permalink
Fix busted doc comment (#1392)
Browse files Browse the repository at this point in the history
* 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 <[email protected]>
  • Loading branch information
notriddle and mmastrac authored Feb 3, 2024
1 parent d719d4b commit 54e9338
Showing 1 changed file with 3 additions and 3 deletions.
6 changes: 3 additions & 3 deletions src/handle.rs
Original file line number Diff line number Diff line change
Expand Up @@ -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 ()>);
Expand Down

0 comments on commit 54e9338

Please sign in to comment.