Improve docs for the ListenBrainz type

This commit is contained in:
Koen Bolhuis 2021-01-20 00:57:03 +01:00
parent b4c4226677
commit ae9b342474
1 changed files with 3 additions and 1 deletions

View File

@ -22,7 +22,7 @@ pub struct ListenBrainz {
} }
impl ListenBrainz { impl ListenBrainz {
/// Construct a new ListenBrainz client. /// Construct a new ListenBrainz client that is not authenticated.
pub fn new() -> Self { pub fn new() -> Self {
Self { Self {
client: Client::new(), client: Client::new(),
@ -47,6 +47,8 @@ impl ListenBrainz {
/// Authenticate this client with the given token. /// Authenticate this client with the given token.
/// If the token is valid, authenticates the client and returns [`Ok`]. /// If the token is valid, authenticates the client and returns [`Ok`].
/// In case the client was already authenticated, the old information
/// is discarded and the new token will be used.
/// ///
/// # Errors /// # Errors
/// ///