From 0a523d54c1f85c8d91ea2b61317e761d7306a44c Mon Sep 17 00:00:00 2001 From: Flori Weber Date: Tue, 20 Jun 2023 22:30:42 +0200 Subject: [PATCH] Multiline docstring to single line docstring --- src/api/users/users.rs | 22 ++++++++++++---------- 1 file changed, 12 insertions(+), 10 deletions(-) diff --git a/src/api/users/users.rs b/src/api/users/users.rs index 5bd509b..bf7b94f 100644 --- a/src/api/users/users.rs +++ b/src/api/users/users.rs @@ -10,16 +10,18 @@ use crate::{ }; impl UserMeta { - /** - Get a user object by id, or get the current user. - # Arguments - * `token` - A valid access token for the API. - * `url_api` - The URL to the API. - * `id` - The id of the user that will be retrieved. If this is None, the current user will be retrieved. - * `instance_limits` - The [`Limits`] of the instance. - # Errors - * [`ChorusLibError`] - If the request fails. - */ + /// Get a user object by id, or get the current user. + /// + /// # Arguments + /// + /// * `token` - A valid access token for the API. + /// * `url_api` - The URL to the API. + /// * `id` - The id of the user that will be retrieved. If this is None, the current user will be retrieved. + /// * `instance_limits` - The [`Limits`] of the instance. + /// + /// # Errors + /// + /// * [`ChorusLibError`] - If the request fails. pub async fn get(user: &mut UserMeta, id: Option<&String>) -> Result { User::get(user, id).await }