Skip to content

Commit 3d1ae98

Browse files
committed
Update docs
1 parent 8c93948 commit 3d1ae98

7 files changed

Lines changed: 6 additions & 52 deletions

File tree

src/function.rs

Lines changed: 0 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -3,12 +3,6 @@
33
//! This module provides types for working with Lua functions from Rust, including
44
//! both Lua-defined functions and native Rust callbacks.
55
//!
6-
//! # Main Types
7-
//!
8-
//! - [`Function`] - A handle to a Lua function that can be called from Rust.
9-
//! - [`FunctionInfo`] - Debug information about a function (name, source, line numbers, etc.).
10-
//! - [`CoverageInfo`] - Code coverage data for Luau functions (requires `luau` feature).
11-
//!
126
//! # Calling Functions
137
//!
148
//! Use [`Function::call`] to invoke a Lua function synchronously:

src/lib.rs

Lines changed: 4 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -154,15 +154,12 @@ pub use crate::debug::HookTriggers;
154154
#[cfg_attr(docsrs, doc(cfg(feature = "luau")))]
155155
pub use crate::{buffer::Buffer, vector::Vector};
156156

157-
#[cfg(feature = "serde")]
158-
#[doc(inline)]
159-
pub use crate::serde::LuaSerdeExt;
160157
#[cfg(feature = "serde")]
161158
#[doc(hidden)]
162-
pub use crate::{
163-
serde::{DeserializeOptions, SerializeOptions},
164-
value::SerializableValue,
165-
};
159+
pub use crate::serde::{DeserializeOptions, SerializeOptions};
160+
#[cfg(feature = "serde")]
161+
#[doc(inline)]
162+
pub use crate::{serde::LuaSerdeExt, value::SerializableValue};
166163

167164
#[cfg(feature = "serde")]
168165
#[cfg_attr(docsrs, doc(cfg(feature = "serde")))]

src/luau/mod.rs

Lines changed: 2 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,9 @@
11
//! Luau-specific extensions and types.
22
//!
3-
//! This module provides Luau-specific functionality including custom `require` implementations,
3+
//! This module provides Luau-specific functionality including custom [`require`] implementations,
44
//! heap memory analysis, and Luau VM integration utilities.
55
//!
6-
//! # Overview
7-
//!
8-
//! - [`Require`] — trait for implementing custom module loaders used with
9-
//! [`Lua::create_require_function`]
10-
//! - [`FsRequirer`] — default filesystem-based [`Require`] implementation
11-
//! - [`NavigateError`] — error type returned when navigating the module path
12-
//! - [`HeapDump`] — snapshot of Luau heap memory usage, obtained via [`Lua::heap_dump`]
13-
//!
14-
//! [`Lua::create_require_function`]: crate::Lua::create_require_function
15-
//! [`Lua::heap_dump`]: crate::Lua::heap_dump
6+
//! [`require`]: crate::Lua::create_require_function
167
178
use std::ffi::{CStr, CString};
189
use std::os::raw::c_int;

src/serde/mod.rs

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -242,7 +242,5 @@ static ARRAY_METATABLE_REGISTRY_KEY: u8 = 0;
242242
pub mod de;
243243
pub mod ser;
244244

245-
#[doc(inline)]
246245
pub use de::{Deserializer, Options as DeserializeOptions};
247-
#[doc(inline)]
248246
pub use ser::{Options as SerializeOptions, Serializer};

src/string.rs

Lines changed: 0 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,6 @@
11
//! Lua string handling.
22
//!
33
//! This module provides types for working with Lua strings from Rust.
4-
//!
5-
//! # Main Types
6-
//!
7-
//! - [`LuaString`] - A handle to an internal Lua string (may not be valid UTF-8).
8-
//! - [`BorrowedStr`] - A borrowed `&str` view of a Lua string that holds a strong reference to the
9-
//! Lua state.
10-
//! - [`BorrowedBytes`] - A borrowed `&[u8]` view of a Lua string that holds a strong reference to
11-
//! the Lua state.
124
135
use std::borrow::Borrow;
146
use std::hash::{Hash, Hasher};

src/table.rs

Lines changed: 0 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -3,12 +3,6 @@
33
//! Tables are Lua's primary data structure, used for arrays, dictionaries, objects, modules,
44
//! and more. This module provides types for creating and manipulating Lua tables from Rust.
55
//!
6-
//! # Main Types
7-
//!
8-
//! - [`Table`] - A handle to a Lua table.
9-
//! - [`TablePairs`] - An iterator over key-value pairs in a table.
10-
//! - [`TableSequence`] - An iterator over the array (sequence) portion of a table.
11-
//!
126
//! # Basic Operations
137
//!
148
//! Tables support key-value access similar to Rust's `HashMap`:

src/userdata.rs

Lines changed: 0 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,6 @@
11
//! Lua userdata handling.
22
//!
33
//! This module provides types for creating and working with Lua userdata from Rust.
4-
//!
5-
//! # Main Types
6-
//!
7-
//! - [`AnyUserData`] - A handle to a Lua userdata value of any Rust type.
8-
//! - [`UserData`] - Trait to implement for types that should be exposed to Lua as userdata.
9-
//! - [`UserDataFields`] - Trait for registering fields on userdata types.
10-
//! - [`UserDataMethods`] - Trait for registering methods on userdata types.
11-
//! - [`UserDataRegistry`] - Registry for userdata methods and fields.
12-
//! - [`UserDataMetatable`] - A handle to the metatable of a userdata type.
13-
//! - [`UserDataRef`] - A borrowed reference to a userdata value.
14-
//! - [`UserDataRefMut`] - A mutably borrowed reference to a userdata value.
15-
//! - [`MetaMethod`] - Metamethod names for customizing Lua operators.
164
175
use std::any::TypeId;
186
use std::ffi::CStr;

0 commit comments

Comments
 (0)