Skip to content

Commit

Permalink
refactor: [torrust#1195] remove deprecated context section in docs
Browse files Browse the repository at this point in the history
It was used to group methods by services in the old core tracker.
  • Loading branch information
josecelano committed Jan 21, 2025
1 parent 12a62ce commit a93a79c
Showing 1 changed file with 0 additions and 18 deletions.
18 changes: 0 additions & 18 deletions src/core/authentication/mod.rs
Original file line number Diff line number Diff line change
Expand Up @@ -60,8 +60,6 @@ impl Facade {
/// # Errors
///
/// Will return an error if the the authentication key cannot be verified.
///
/// # Context: Authentication
pub async fn authenticate(&self, key: &Key) -> Result<(), Error> {
if self.is_private() {
self.verify_auth_key(key).await
Expand All @@ -77,8 +75,6 @@ impl Facade {

/// It verifies an authentication key.
///
/// # Context: Authentication
///
/// # Errors
///
/// Will return a `key::Error` if unable to get any `auth_key`.
Expand Down Expand Up @@ -180,8 +176,6 @@ impl Facade {
///
/// Authentication keys are used by HTTP trackers.
///
/// # Context: Authentication
///
/// # Errors
///
/// Will return a `database::Error` if unable to add the `auth_key` to the database.
Expand All @@ -193,8 +187,6 @@ impl Facade {
///
/// Authentication keys are used by HTTP trackers.
///
/// # Context: Authentication
///
/// # Errors
///
/// Will return a `database::Error` if unable to add the `auth_key` to the database.
Expand All @@ -217,8 +209,6 @@ impl Facade {
///
/// Authentication keys are used by HTTP trackers.
///
/// # Context: Authentication
///
/// # Errors
///
/// Will return a `database::Error` if unable to add the `auth_key` to the
Expand All @@ -235,8 +225,6 @@ impl Facade {
///
/// Authentication keys are used by HTTP trackers.
///
/// # Context: Authentication
///
/// # Errors
///
/// Will return a `database::Error` if unable to add the `auth_key` to the
Expand Down Expand Up @@ -266,8 +254,6 @@ impl Facade {

/// It removes an authentication key.
///
/// # Context: Authentication
///
/// # Errors
///
/// Will return a `database::Error` if unable to remove the `key` to the database.
Expand All @@ -280,8 +266,6 @@ impl Facade {
}

/// It removes an authentication key from memory.
///
/// # Context: Authentication
pub async fn remove_in_memory_auth_key(&self, key: &Key) {
self.in_memory_key_repository.remove(key).await;
}
Expand All @@ -291,8 +275,6 @@ impl Facade {
/// into memory with this function. Keys are automatically stored in the database when they
/// are generated.
///
/// # Context: Authentication
///
/// # Errors
///
/// Will return a `database::Error` if unable to `load_keys` from the database.
Expand Down

0 comments on commit a93a79c

Please sign in to comment.