[PR #319] [MERGED] Improve example docs and minimal features #394

New issue

Closed

opened 2026-02-27 20:24:32 +03:00 by kerem · 0 comments

kerem commented

2026-02-27 20:24:32 +03:00

Owner

📋 Pull Request Information

Original PR: https://github.com/ramsayleung/rspotify/pull/319
Author: @marioortizmanero
Created: 5/25/2022
Status: ✅ Merged
Merged: 5/25/2022
Merged by: @marioortizmanero

Base: master ← Head: tidy-examples

📝 Commits (1)

e516e4a Improve example docs and minimal features

📊 Changes

16 files changed (+45 additions, -13 deletions)

View changed files

📝 Cargo.toml (+4 -4)
📝 examples/auth_code.rs (+3 -2)
📝 examples/auth_code_pkce.rs (+3 -1)
📝 examples/client_creds.rs (+2 -2)
📝 examples/oauth_tokens.rs (+3 -2)
📝 examples/pagination_async.rs (+3 -0)
📝 examples/pagination_manual.rs (+3 -0)
📝 examples/pagination_sync.rs (+3 -0)
📝 examples/tasks.rs (+2 -0)
📝 examples/ureq/device.rs (+3 -0)
📝 examples/ureq/me.rs (+3 -0)
📝 examples/ureq/search.rs (+2 -0)
📝 examples/ureq/seek_track.rs (+3 -0)
📝 examples/ureq/threading.rs (+2 -0)
📝 examples/with_auto_reauth.rs (+3 -1)
📝 examples/with_refresh_token.rs (+3 -1)

📄 Description

Description

This updates the docs in the examples so that users like @Staninna don't go through the same issues as #318. This library is quite high level, so I imagine it will be used by not-so-experienced users. Making it as easy to use as possible is a good idea.

I also noticed that some examples don't need the cli feature enabled, so I removed it from our Cargo.toml.

Dependencies

None

Type of change

Please delete options that are not relevant.

Bug fix (non-breaking change which fixes an issue)
This change requires a documentation update

How has this been tested?

The tests still run just fine

Is this change properly documented?

Yes

_{🔄 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/319 **Author:** [@marioortizmanero](https://github.com/marioortizmanero) **Created:** 5/25/2022 **Status:** ✅ Merged **Merged:** 5/25/2022 **Merged by:** [@marioortizmanero](https://github.com/marioortizmanero) **Base:** `master` ← **Head:** `tidy-examples` --- ### 📝 Commits (1) - [`e516e4a`](https://github.com/ramsayleung/rspotify/commit/e516e4ae6e6a04b852dc5b0fb0717853948790e9) Improve example docs and minimal features ### 📊 Changes **16 files changed** (+45 additions, -13 deletions) <details> <summary>View changed files</summary> 📝 `Cargo.toml` (+4 -4) 📝 `examples/auth_code.rs` (+3 -2) 📝 `examples/auth_code_pkce.rs` (+3 -1) 📝 `examples/client_creds.rs` (+2 -2) 📝 `examples/oauth_tokens.rs` (+3 -2) 📝 `examples/pagination_async.rs` (+3 -0) 📝 `examples/pagination_manual.rs` (+3 -0) 📝 `examples/pagination_sync.rs` (+3 -0) 📝 `examples/tasks.rs` (+2 -0) 📝 `examples/ureq/device.rs` (+3 -0) 📝 `examples/ureq/me.rs` (+3 -0) 📝 `examples/ureq/search.rs` (+2 -0) 📝 `examples/ureq/seek_track.rs` (+3 -0) 📝 `examples/ureq/threading.rs` (+2 -0) 📝 `examples/with_auto_reauth.rs` (+3 -1) 📝 `examples/with_refresh_token.rs` (+3 -1) </details> ### 📄 Description ## Description This updates the docs in the examples so that users like @Staninna don't go through the same issues as #318. This library is quite high level, so I imagine it will be used by not-so-experienced users. Making it as easy to use as possible is a good idea. I also noticed that some examples don't need the `cli` feature enabled, so I removed it from our `Cargo.toml`. ## Dependencies None ## Type of change Please delete options that are not relevant. - [x] Bug fix (non-breaking change which fixes an issue) - [x] This change requires a documentation update ## How has this been tested? The tests still run just fine ## Is this change properly documented? Yes --- <sub>🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.</sub>