diff --git a/crates/lb/src/chan.rs b/crates/lb/src/chan.rs index 491f63f..a096dd3 100644 --- a/crates/lb/src/chan.rs +++ b/crates/lb/src/chan.rs @@ -11,7 +11,7 @@ use luaffi::{cdef, metatype}; /// Items exported by the `lb:chan` library. /// /// This library can be acquired by calling -/// [`require("lb:chan")`](https://www.lua.org/manual/5.1/manual.html#pdf-require) in Lua. +/// [`require("lb:chan")`](https://www.lua.org/manual/5.1/manual.html#pdf-require). /// /// ```lua /// local chan = require("lb:chan"); diff --git a/crates/lb/src/fs.rs b/crates/lb/src/fs.rs index a100c99..b6a83a5 100644 --- a/crates/lb/src/fs.rs +++ b/crates/lb/src/fs.rs @@ -22,14 +22,14 @@ use thiserror::Error; /// Errors that can be thrown by this library. /// -/// Functions which return this error will **throw** in Lua. The error message can be caught by -/// using [`pcall(f, ...)`](https://www.lua.org/manual/5.1/manual.html#pdf-pcall). +/// Functions which return this error will **throw**. The error message can be caught by using +/// [`pcall(f, ...)`](https://www.lua.org/manual/5.1/manual.html#pdf-pcall). #[derive(Debug, Error)] pub enum Error { /// Attempt to access an object while it is being modified. #[error("cannot access object while it is being modified")] Borrow(#[from] BorrowError), - /// Attempt to modify an object while it is in use + /// Attempt to modify an object while it is in use. #[error("cannot modify object while it is in use")] BorrowMut(#[from] BorrowMutError), /// I/O error. @@ -48,7 +48,7 @@ type Result = std::result::Result; /// Items exported by the `lb:fs` library. /// /// This library can be acquired by calling -/// [`require("lb:fs")`](https://www.lua.org/manual/5.1/manual.html#pdf-require) in Lua. +/// [`require("lb:fs")`](https://www.lua.org/manual/5.1/manual.html#pdf-require). /// /// ```lua /// local fs = require("lb:fs"); diff --git a/crates/lb/src/lib.rs b/crates/lb/src/lib.rs index c74751f..975de0b 100644 --- a/crates/lb/src/lib.rs +++ b/crates/lb/src/lib.rs @@ -1,5 +1,4 @@ //! luby standard library -#![warn(missing_docs)] #[cfg(feature = "task")] pub mod chan; #[cfg(feature = "fs")] diff --git a/crates/lb/src/net.rs b/crates/lb/src/net.rs index 5783bcc..943b205 100644 --- a/crates/lb/src/net.rs +++ b/crates/lb/src/net.rs @@ -28,14 +28,14 @@ use tokio::{ /// Errors that can be thrown by this library. /// -/// Functions which return this error will **throw** in Lua. The error message can be caught by -/// using [`pcall(f, ...)`](https://www.lua.org/manual/5.1/manual.html#pdf-pcall). +/// Functions which return this error will **throw**. The error message can be caught by using +/// [`pcall(f, ...)`](https://www.lua.org/manual/5.1/manual.html#pdf-pcall). #[derive(Debug, Error)] pub enum Error { /// Attempt to access an object while it is being modified. #[error("cannot access object while it is being modified")] Borrow(#[from] BorrowError), - /// Attempt to modify an object while it is in use + /// Attempt to modify an object while it is in use. #[error("cannot modify object while it is in use")] BorrowMut(#[from] BorrowMutError), /// I/O error. @@ -54,7 +54,7 @@ type Result = std::result::Result; /// Items exported by the `lb:net` library. /// /// This library can be acquired by calling -/// [`require("lb:net")`](https://www.lua.org/manual/5.1/manual.html#pdf-require) in Lua. +/// [`require("lb:net")`](https://www.lua.org/manual/5.1/manual.html#pdf-require). /// /// ```lua /// local net = require("lb:net"); @@ -501,9 +501,9 @@ impl lb_ipaddr { /// Socket address, which is an IP address with a port number. /// -/// This represents a combination of an IP address and a port, such as `127.0.0.1:8080` or -/// `[::1]:443`. It is used to specify endpoints for network connections and listeners, and can be -/// constructed by [`socketaddr`](lb_libnet::socketaddr). +/// This represents an IP address with a prescribed port, such as `127.0.0.1:8080` or `[::1]:443`. +/// It is used to specify endpoints for network connections and listeners, and can be constructed by +/// [`socketaddr`](lb_netlib::socketaddr). #[derive(Debug, Clone, Copy, PartialEq, Eq, From, FromStr)] #[cdef] pub struct lb_socketaddr(#[opaque] SocketAddr); diff --git a/crates/lb/src/task.rs b/crates/lb/src/task.rs index ab1e7c7..38e1ec9 100644 --- a/crates/lb/src/task.rs +++ b/crates/lb/src/task.rs @@ -19,7 +19,7 @@ use tokio::{task::JoinHandle, time::sleep}; /// Items exported by the `lb:task` library. /// /// This library can be acquired by calling -/// [`require("lb:task")`](https://www.lua.org/manual/5.1/manual.html#pdf-require) in Lua. +/// [`require("lb:task")`](https://www.lua.org/manual/5.1/manual.html#pdf-require). /// /// ```lua /// local task = require("lb:task");