Multiline docstring to single line docstring

This commit is contained in:
Flori Weber 2023-06-20 22:30:42 +02:00
parent 1fc38b25bf
commit 0a523d54c1
No known key found for this signature in database
GPG Key ID: 0ACD574FCF5226CF
1 changed files with 12 additions and 10 deletions

View File

@ -10,16 +10,18 @@ use crate::{
}; };
impl UserMeta { impl UserMeta {
/** /// Get a user object by id, or get the current user.
Get a user object by id, or get the current user. ///
# Arguments /// # Arguments
* `token` - A valid access token for the API. ///
* `url_api` - The URL to the API. /// * `token` - A valid access token for the API.
* `id` - The id of the user that will be retrieved. If this is None, the current user will be retrieved. /// * `url_api` - The URL to the API.
* `instance_limits` - The [`Limits`] of the instance. /// * `id` - The id of the user that will be retrieved. If this is None, the current user will be retrieved.
# Errors /// * `instance_limits` - The [`Limits`] of the instance.
* [`ChorusLibError`] - If the request fails. ///
*/ /// # Errors
///
/// * [`ChorusLibError`] - If the request fails.
pub async fn get(user: &mut UserMeta, id: Option<&String>) -> Result<User, ChorusLibError> { pub async fn get(user: &mut UserMeta, id: Option<&String>) -> Result<User, ChorusLibError> {
User::get(user, id).await User::get(user, id).await
} }