[PR #325] [MERGED] Remove undocumented modules containing one item #395

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

📋 Pull Request Information

Original PR: https://github.com/ramsayleung/rspotify/pull/325
Author: @SabrinaJewson
Created: 6/15/2022
Status: Merged
Merged: 6/15/2022
Merged by: @marioortizmanero

Base: masterHead: remove-modules


📝 Commits (3)

  • afaf5d5 Remove auth_code[_pkce] and client_creds modules
  • f642923 Remove clients::{base, oauth}
  • a6cac3f Document modules removal in changelog

📊 Changes

3 files changed (+10 additions, -5 deletions)

View changed files

📝 CHANGELOG.md (+5 -0)
📝 src/clients/mod.rs (+2 -2)
📝 src/lib.rs (+3 -3)

📄 Description

Description

This removes the modules auth_code, auth_code_pkce, client_creds, clients::base and clients::oauth from the public API surface.

Motivation and Context

These modules are unnecessary because they only export a single item which has the same name as the module itself anyway. Documentation is easier to navigate if they’re not present.

I left out mutex because I have other plans for that module.

Dependencies

None.

Type of change

  • Breaking change (fix or feature that would cause existing functionality to not work as expected)

How has this been tested?

Please describe the tests that you ran to verify your changes. Provide instructions so we can reproduce.

Please also list any relevant details for your test configuration

  • Test A: cargo test --features env-file

Is this change properly documented?

  • Will add a changelog entry once I have a PR number.

🔄 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/325 **Author:** [@SabrinaJewson](https://github.com/SabrinaJewson) **Created:** 6/15/2022 **Status:** ✅ Merged **Merged:** 6/15/2022 **Merged by:** [@marioortizmanero](https://github.com/marioortizmanero) **Base:** `master` ← **Head:** `remove-modules` --- ### 📝 Commits (3) - [`afaf5d5`](https://github.com/ramsayleung/rspotify/commit/afaf5d57a9714628e32c7f70ec6489cc2693acc8) Remove `auth_code[_pkce]` and `client_creds` modules - [`f642923`](https://github.com/ramsayleung/rspotify/commit/f642923e78ec6a9da34e97b54cd6785ec54fd3ef) Remove `clients::{base, oauth}` - [`a6cac3f`](https://github.com/ramsayleung/rspotify/commit/a6cac3fd8f105102e975b794d6895e3c1cc4b5bb) Document modules removal in changelog ### 📊 Changes **3 files changed** (+10 additions, -5 deletions) <details> <summary>View changed files</summary> 📝 `CHANGELOG.md` (+5 -0) 📝 `src/clients/mod.rs` (+2 -2) 📝 `src/lib.rs` (+3 -3) </details> ### 📄 Description ## Description This removes the modules `auth_code`, `auth_code_pkce`, `client_creds`, `clients::base` and `clients::oauth` from the public API surface. ## Motivation and Context These modules are unnecessary because they only export a single item which has the same name as the module itself anyway. Documentation is easier to navigate if they’re not present. I left out `mutex` because I have other plans for that module. ## Dependencies None. ## Type of change - [x] Breaking change (fix or feature that would cause existing functionality to not work as expected) ## How has this been tested? Please describe the tests that you ran to verify your changes. Provide instructions so we can reproduce. Please also list any relevant details for your test configuration - [x] Test A: `cargo test --features env-file` ## Is this change properly documented? - [x] Will add a changelog entry once I have a PR number. --- <sub>🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.</sub>
kerem 2026-02-27 20:24:34 +03:00
Sign in to join this conversation.
No milestone
No project
No assignees
1 participant
Notifications
Due date
The due date is invalid or out of range. Please use the format "yyyy-mm-dd".

No due date set.

Dependencies

No dependencies set.

Reference
starred/rspotify#395
No description provided.