Add documentation

This commit is contained in:
bitfl0wer 2023-05-28 22:40:37 +02:00
parent a189d2baaa
commit f2824f3a81
1 changed files with 13 additions and 0 deletions

View File

@ -39,6 +39,19 @@ impl Channel {
}
}
/// Deletes a channel.
///
/// # Arguments
///
/// * `token` - A string slice that holds the authorization token.
/// * `url_api` - A string slice that holds the URL of the API.
/// * `channel` - A `Channel` object that represents the channel to be deleted.
/// * `limits_user` - A mutable reference to a `Limits` object that represents the user's rate limits.
/// * `limits_instance` - A mutable reference to a `Limits` object that represents the instance's rate limits.
///
/// # Returns
///
/// An `Option` that contains an `InstanceServerError` if an error occurred during the request, or `None` if the request was successful.
pub async fn delete(
token: &str,
url_api: &str,