[PR #102] [MERGED] Slightly better documentation, comment formatting, proposal for more changes #245

New issue

Closed

opened 2026-02-27 20:23:56 +03:00 by kerem · 0 comments

kerem commented

2026-02-27 20:23:56 +03:00

Owner

📋 Pull Request Information

Original PR: https://github.com/ramsayleung/rspotify/pull/102
Author: @marioortizmanero
Created: 7/13/2020
Status: ✅ Merged
Merged: 7/19/2020
Merged by: @ramsayleung

Base: master ← Head: master

📝 Commits (3)

740b757 Slightly better documentation, comment formatting
a4465e8 README.md improvements
8539b8c cargo fmt

📊 Changes

27 files changed (+874 additions, -881 deletions)

View changed files

📝 README.md (+20 -27)
📝 examples/add_to_queue.rs (+1 -1)
📝 examples/next_playback.rs (+1 -1)
📝 examples/previous_playback.rs (+1 -1)
📝 src/blocking/client.rs (+387 -388)
📝 src/blocking/oauth2.rs (+10 -10)
📝 src/blocking/util.rs (+9 -9)
📝 src/client.rs (+344 -345)
📝 src/lib.rs (+39 -39)
📝 src/model/album.rs (+4 -4)
📝 src/model/artist.rs (+2 -2)
📝 src/model/audio.rs (+6 -6)
📝 src/model/category.rs (+2 -2)
📝 src/model/context.rs (+4 -4)
📝 src/model/cud_result.rs (+1 -1)
📝 src/model/device.rs (+1 -1)
📝 src/model/image.rs (+1 -1)
📝 src/model/offset.rs (+1 -1)
📝 src/model/page.rs (+6 -6)
📝 src/model/playing.rs (+4 -4)

...and 7 more files

📄 Description

Hi @ramsayleung!

I was going to use this library for one of my projects and I've decided I'm going to help a bit. I've formatted consistently and correctly the comments for each endpoint with a vim macro, and have made very small changes to the docs, hoping they're more clear now.

I would love to run a cargo fmt to clean everything up automatically, but I understand it'd be better to first merge the two other PRs pending to avoid messing up the diffs.

Another thing I really want to change is the repetition between blocking/cilent.rs and client.rs. A macro would come in perfectly here to unify blocking and async and I think would make it super easy to add/update new endpoints. I'll make a new PR if you're okay with that (if I manage to get it working). There's got to be a solution for that already anyway, I'll have to investigate. I should open a new issue for that, right?

Edit: I've seen that there's a CI run for cargo fmt, which is failing. Should I just run it in a new commit, then?

_{🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.}

## 📋 Pull Request Information **Original PR:** https://github.com/ramsayleung/rspotify/pull/102 **Author:** [@marioortizmanero](https://github.com/marioortizmanero) **Created:** 7/13/2020 **Status:** ✅ Merged **Merged:** 7/19/2020 **Merged by:** [@ramsayleung](https://github.com/ramsayleung) **Base:** `master` ← **Head:** `master` --- ### 📝 Commits (3) - [`740b757`](https://github.com/ramsayleung/rspotify/commit/740b757b1fd22c62d2760eb48bc33d6f0bcf3f7c) Slightly better documentation, comment formatting - [`a4465e8`](https://github.com/ramsayleung/rspotify/commit/a4465e8354dca84b70237e4d8ce1b27eeb55a686) README.md improvements - [`8539b8c`](https://github.com/ramsayleung/rspotify/commit/8539b8c310c048d425e9d7f8dd9c95814dae3093) cargo fmt ### 📊 Changes **27 files changed** (+874 additions, -881 deletions) <details> <summary>View changed files</summary> 📝 `README.md` (+20 -27) 📝 `examples/add_to_queue.rs` (+1 -1) 📝 `examples/next_playback.rs` (+1 -1) 📝 `examples/previous_playback.rs` (+1 -1) 📝 `src/blocking/client.rs` (+387 -388) 📝 `src/blocking/oauth2.rs` (+10 -10) 📝 `src/blocking/util.rs` (+9 -9) 📝 `src/client.rs` (+344 -345) 📝 `src/lib.rs` (+39 -39) 📝 `src/model/album.rs` (+4 -4) 📝 `src/model/artist.rs` (+2 -2) 📝 `src/model/audio.rs` (+6 -6) 📝 `src/model/category.rs` (+2 -2) 📝 `src/model/context.rs` (+4 -4) 📝 `src/model/cud_result.rs` (+1 -1) 📝 `src/model/device.rs` (+1 -1) 📝 `src/model/image.rs` (+1 -1) 📝 `src/model/offset.rs` (+1 -1) 📝 `src/model/page.rs` (+6 -6) 📝 `src/model/playing.rs` (+4 -4) _...and 7 more files_ </details> ### 📄 Description Hi @ramsayleung! I was going to use this library for one of my projects and I've decided I'm going to help a bit. I've formatted consistently and correctly the comments for each endpoint with a vim macro, and have made very small changes to the docs, hoping they're more clear now. I would love to run a `cargo fmt` to clean everything up automatically, but I understand it'd be better to first merge the two other PRs pending to avoid messing up the diffs. Another thing I really want to change is the repetition between `blocking/cilent.rs` and `client.rs`. A macro would come in perfectly here to unify blocking and async and I think would make it super easy to add/update new endpoints. I'll make a new PR if you're okay with that (if I manage to get it working). There's got to be a solution for that already anyway, I'll have to investigate. I should open a new issue for that, right? Edit: I've seen that there's a CI run for cargo fmt, which is failing. Should I just run it in a new commit, then? --- <sub>🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.</sub>