docs: small overall documentation improvements (#1381)

* docs: small overall documentation improvements

- Add documentation comments to various items
- Change web API return types from bool/Option to Result
- Create helper functions with descriptive names instead of comments
- Remove redundant/confusing types
- Fix some documentation comments as instructed by `cargo doc`
- Rename variables to clear names

* docs: small fixes to the documentation update
This commit is contained in:
Thomas Frans
2024-02-01 19:42:53 +01:00
committed by GitHub
parent 8805464b1d
commit c5d666f35c
18 changed files with 312 additions and 151 deletions

View File

@@ -67,6 +67,7 @@ impl Playlist {
match spotify
.api
.delete_tracks(&self.id, &self.snapshot_id, &[playable])
.is_ok()
{
false => false,
true => {
@@ -83,7 +84,11 @@ impl Playlist {
pub fn append_tracks(&mut self, new_tracks: &[Playable], spotify: &Spotify, library: &Library) {
let mut has_modified = false;
if spotify.api.append_tracks(&self.id, new_tracks, None) {
if spotify
.api
.append_tracks(&self.id, new_tracks, None)
.is_ok()
{
if let Some(tracks) = &mut self.tracks {
tracks.append(&mut new_tracks.to_vec());
has_modified = true;
@@ -304,6 +309,7 @@ impl ListItem for Playlist {
None,
Some(track_ids.iter().map(|t| t.as_ref()).collect()),
)
.ok()
.map(|r| r.tracks)
.map(|tracks| tracks.iter().map(Track::from).collect());