Skip to content

Commit 74d0d28

Browse files
committed
docs: [#1261] fix doc errors in tracker-core
1 parent efe7e98 commit 74d0d28

File tree

5 files changed

+5
-21
lines changed

5 files changed

+5
-21
lines changed

packages/tracker-core/src/authentication/key/mod.rs

+2-2
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
//!
77
//! There are services to [`generate_key`] and [`verify_key_expiration`] authentication keys.
88
//!
9-
//! Authentication keys are used only by [`HTTP`](crate::servers::http) trackers. All keys have an expiration time, that means
9+
//! Authentication keys are used only by HTTP trackers. All keys have an expiration time, that means
1010
//! they are only valid during a period of time. After that time the expiring key will no longer be valid.
1111
//!
1212
//! Keys are stored in this struct:
@@ -112,7 +112,7 @@ pub fn generate_key(lifetime: Option<Duration>) -> PeerKey {
112112
///
113113
/// # Errors
114114
///
115-
/// Will return a verification error [`crate::authentication::key::Error`] if
115+
/// Will return a verification error [`enum@crate::authentication::key::Error`] if
116116
/// it cannot verify the key.
117117
pub fn verify_key_expiration(auth_key: &PeerKey) -> Result<(), Error> {
118118
let current_time: DurationSinceUnixEpoch = CurrentClock::now();

packages/tracker-core/src/databases/driver/mod.rs

-3
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,4 @@
11
//! Database driver factory.
2-
//!
3-
//! See [`databases::driver::build`](crate::core::databases::driver::build)
4-
//! function for more information.
52
use mysql::Mysql;
63
use serde::{Deserialize, Serialize};
74
use sqlite::Sqlite;

packages/tracker-core/src/databases/error.rs

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
//! Database errors.
22
//!
3-
//! This module contains the [Database errors](crate::core::databases::error::Error).
3+
//! This module contains the [Database errors](crate::databases::error::Error).
44
use std::panic::Location;
55
use std::sync::Arc;
66

packages/tracker-core/src/databases/mod.rs

+2-2
Original file line numberDiff line numberDiff line change
@@ -4,8 +4,8 @@
44
//!
55
//! There are two implementations of the trait (two drivers):
66
//!
7-
//! - [`Mysql`](crate::core::databases::mysql::Mysql)
8-
//! - [`Sqlite`](crate::core::databases::sqlite::Sqlite)
7+
//! - `Mysql`
8+
//! - `Sqlite`
99
//!
1010
//! > **NOTICE**: There are no database migrations. If there are any changes,
1111
//! > we will implemented them or provide a script to migrate to the new schema.

packages/tracker-core/src/lib.rs

-13
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,6 @@
2525
//! - [Torrents](#torrents)
2626
//! - [Peers](#peers)
2727
//! - [Configuration](#configuration)
28-
//! - [Services](#services)
2928
//! - [Authentication](#authentication)
3029
//! - [Statistics](#statistics)
3130
//! - [Persistence](#persistence)
@@ -342,18 +341,6 @@
342341
//!
343342
//! Refer to the [`configuration` module documentation](https://docs.rs/torrust-tracker-configuration) to get more information about all options.
344343
//!
345-
//! # Services
346-
//!
347-
//! Services are domain services on top of the core tracker domain. Right now there are two types of service:
348-
//!
349-
//! - For statistics: [`crate::packages::statistics::services`]
350-
//! - For torrents: [`crate::core::torrent::services`]
351-
//!
352-
//! Services usually format the data inside the tracker to make it easier to consume by other parts.
353-
//! They also decouple the internal data structure, used by the tracker, from the way we deliver that data to the consumers.
354-
//! The internal data structure is designed for performance or low memory consumption. And it should be changed
355-
//! without affecting the external consumers.
356-
//!
357344
//! Services can include extra features like pagination, for example.
358345
//!
359346
//! # Authentication

0 commit comments

Comments
 (0)