Replace references to arti-client in the documentation.

This commit is contained in:
Nick Mathewson 2021-10-21 14:19:34 -04:00
parent 7c7a388e28
commit 730be38867
8 changed files with 11 additions and 11 deletions

View File

@ -2,7 +2,7 @@
//!
//! # Semver note
//!
//! Most types in this module are re-exported by `tor-client`.
//! Most types in this module are re-exported by `arti-client`.
use derive_builder::Builder;
use serde::Deserialize;

View File

@ -288,7 +288,7 @@ impl<R: Runtime> CircMgr<R> {
/// # Note
///
/// This function is invoked periodically from the
/// `arti-tor-client` crate, based on timings from the network
/// `arti-arti-client` crate, based on timings from the network
/// parameters. Please don't invoke it on your own; I hope we can
/// have this API go away in the future.
///

View File

@ -68,8 +68,8 @@ impl TargetPort {
///
/// # Semver note
///
/// This type is re-exported by `tor-client`: any changes to it must be
/// reflected in `tor-client`'s version.
/// This type is re-exported by `arti-client`: any changes to it must be
/// reflected in `arti-client`'s version.
#[derive(Clone, Copy, Debug, PartialEq, Eq)]
pub struct IsolationToken(u64);

View File

@ -5,8 +5,8 @@
//!
//! # Semver note
//!
//! The types in this module are re-exported from `tor-client`: any changes
//! here must be reflected in the version of `tor-client`.
//! The types in this module are re-exported from `arti-client`: any changes
//! here must be reflected in the version of `arti-client`.
use crate::retry::RetryConfig;
use crate::storage::sqlite::SqliteStore;

View File

@ -7,7 +7,7 @@
//!
//! # Semver note
//!
//! The types in this module are re-exported from `tor-client` and
//! The types in this module are re-exported from `arti-client` and
//! `tor-dirmgr`: any changes here must be reflected there.
use derive_builder::Builder;

View File

@ -9,7 +9,7 @@
//! since its APIs are needlessly low-level for most purposes, and it is
//! easy to misuse them in an insecure or privacy-violating way.
//!
//! Most people should use the [`tor-client`] crate instead. This crate is
//! Most people should use the [`arti-client`] crate instead. This crate is
//! of interest mainly for those that want to access the Tor protocols at
//! a low level.
//!
@ -48,7 +48,7 @@
//! [`tor_linkspec::ChanTarget`] and [`tor_linkspec::CircTarget`].
//! Currently, the [`tor-netdir`] crate is the easiest way to do so.
//!
//! For an example of this crate in action, see the [`tor-client`]
//! For an example of this crate in action, see the [`arti-client`]
//! library, or the `arti` CLI.
//!
//! # Design notes

View File

@ -37,7 +37,7 @@ use tor_cell::relaycell::msg::{Data, RelayMsg};
/// # Semver note:
///
/// Note that this type is re-exported as a part of the public API of
/// the `tor-client` crate. Any changes to its API here in
/// the `arti-client` crate. Any changes to its API here in
/// `tor-proto` need to be reflected above.
pub struct DataStream {
/// Underlying writer for this stream

View File

@ -30,7 +30,7 @@
//! needs to know which variant of a subprotocol can be used with a
//! given relay, whereas [`tor-netdoc`] needs to parse lists of
//! subprotocol versions from directory documents. Eventually,
//! [`tor-client`] will need to check its own list of supported
//! [`arti-client`] will need to check its own list of supported
//! protocols against the required list in the consensus.)
#![deny(missing_docs)]