fix links in documentation.

This commit is contained in:
Aaron Weiss 2024-03-18 16:21:31 -07:00
parent ab0d1dda5e
commit 8013504bbf
No known key found for this signature in database
GPG key ID: A932353BB65E4960
4 changed files with 13 additions and 13 deletions

View file

@ -60,7 +60,7 @@ pub enum Command {
/// actually mean sending itself a response. In such a case, you should instead respond to the /// actually mean sending itself a response. In such a case, you should instead respond to the
/// user sending the message as specified in the message prefix. Since this is a common /// user sending the message as specified in the message prefix. Since this is a common
/// pattern, there is a utility function /// pattern, there is a utility function
/// [`Message::response_target`](../message/struct.Message.html#method.response_target) /// [`Message::response_target`]
/// which is used for this exact purpose. /// which is used for this exact purpose.
PRIVMSG(String, String), PRIVMSG(String, String),
/// NOTICE msgtarget :message /// NOTICE msgtarget :message
@ -74,7 +74,7 @@ pub enum Command {
/// actually mean sending itself a response. In such a case, you should instead respond to the /// actually mean sending itself a response. In such a case, you should instead respond to the
/// user sending the message as specified in the message prefix. Since this is a common /// user sending the message as specified in the message prefix. Since this is a common
/// pattern, there is a utility function /// pattern, there is a utility function
/// [`Message::response_target`](../message/struct.Message.html#method.response_target) /// [`Message::response_target`]
/// which is used for this exact purpose. /// which is used for this exact purpose.
NOTICE(String, String), NOTICE(String, String),

View file

@ -13,7 +13,7 @@ use crate::prefix::Prefix;
/// consists of a collection of IRCv3 tags, a prefix (describing the source of the message), and /// consists of a collection of IRCv3 tags, a prefix (describing the source of the message), and
/// the protocol command. If the command is unknown, it is treated as a special raw command that /// the protocol command. If the command is unknown, it is treated as a special raw command that
/// consists of a collection of arguments and the special suffix argument. Otherwise, the command /// consists of a collection of arguments and the special suffix argument. Otherwise, the command
/// is parsed into a more useful form as described in [Command](../command/enum.Command.html). /// is parsed into a more useful form as described in [`Command`].
#[derive(Clone, PartialEq, Debug)] #[derive(Clone, PartialEq, Debug)]
pub struct Message { pub struct Message {
/// Message tags as defined by [IRCv3.2](http://ircv3.net/specs/core/message-tags-3.2.html). /// Message tags as defined by [IRCv3.2](http://ircv3.net/specs/core/message-tags-3.2.html).

View file

@ -1,8 +1,8 @@
//! A simple, thread-safe, and async-friendly IRC client library. //! A simple, thread-safe, and async-friendly IRC client library.
//! //!
//! This API provides the ability to connect to an IRC server via the //! This API provides the ability to connect to an IRC server via the
//! [`Client`](struct.Client.html) type. The [`Client`](trait.Client.html) trait that //! [`Client`] type. The [`Client`] trait that
//! [`Client`](struct.Client.html) implements provides methods for communicating with the //! [`Client`] implements provides methods for communicating with the
//! server. //! server.
//! //!
//! # Examples //! # Examples
@ -22,7 +22,7 @@
//! # } //! # }
//! ``` //! ```
//! //!
//! We can then use functions from [`Client`](trait.Client.html) to receive messages from the //! We can then use functions from [`Client`] to receive messages from the
//! server in a blocking fashion and perform any desired actions in response. The following code //! server in a blocking fashion and perform any desired actions in response. The following code
//! performs a simple call-and-response when the bot's name is mentioned in a channel. //! performs a simple call-and-response when the bot's name is mentioned in a channel.
//! //!
@ -889,7 +889,7 @@ impl Future for Outgoing {
/// The canonical implementation of a connection to an IRC server. /// The canonical implementation of a connection to an IRC server.
/// ///
/// For a full example usage, see [`irc::client`](./index.html). /// For a full example usage, see [`irc::client`].
#[derive(Debug)] #[derive(Debug)]
pub struct Client { pub struct Client {
/// The internal, thread-safe server state. /// The internal, thread-safe server state.
@ -1015,7 +1015,7 @@ impl Client {
None None
} }
/// Gets a list of [`Users`](./data/user/struct.User.html) in the specified channel. If the /// Gets a list of [`Users`] in the specified channel. If the
/// specified channel hasn't been joined or the `channel-lists` feature is disabled, this function /// specified channel hasn't been joined or the `channel-lists` feature is disabled, this function
/// will return `None`. /// will return `None`.
/// ///
@ -1052,7 +1052,7 @@ impl Client {
self.state.current_nickname() self.state.current_nickname()
} }
/// Sends a [`Command`](../proto/command/enum.Command.html) as this `Client`. This is the /// Sends a [`Command`] as this `Client`. This is the
/// core primitive for sending messages to the server. /// core primitive for sending messages to the server.
/// ///
/// # Example /// # Example

View file

@ -1,17 +1,17 @@
//! A simple, thread-safe, and async-friendly library for IRC clients. //! A simple, thread-safe, and async-friendly library for IRC clients.
//! //!
//! # Quick Start //! # Quick Start
//! The main public API is entirely exported in [`client::prelude`](./client/prelude/index.html). //! The main public API is entirely exported in [`client::prelude`].
//! This should include everything necessary to write an IRC client or bot. //! This should include everything necessary to write an IRC client or bot.
//! //!
//! # A Whirlwind Tour //! # A Whirlwind Tour
//! The irc crate is divided into two main modules: [`client`](./client/index.html) and //! The irc crate is divided into two main modules: [`client`] and
//! [`proto`](./proto/index.html). As the names suggest, the `client` module captures the whole of //! [`proto`]. As the names suggest, the `client` module captures the whole of
//! the client-side functionality, while the `proto` module features general components of an IRC //! the client-side functionality, while the `proto` module features general components of an IRC
//! protocol implementation that could in principle be used in either client or server software. //! protocol implementation that could in principle be used in either client or server software.
//! Both modules feature a number of components that are low-level and can be used to build //! Both modules feature a number of components that are low-level and can be used to build
//! alternative APIs for the IRC protocol. For the average user, the higher-level components for an //! alternative APIs for the IRC protocol. For the average user, the higher-level components for an
//! IRC client are all re-exported in [`client::prelude`](./client/prelude/index.html). That module //! IRC client are all re-exported in [`client::prelude`]. That module
//! serves as the best starting point for a new user trying to understand the high-level API. //! serves as the best starting point for a new user trying to understand the high-level API.
//! //!
//! # Example //! # Example