[PR #1185] [MERGED] Convert docstrings to reStructuredText #1201

New issue

Closed

opened 2026-02-28 00:04:04 +03:00 by kerem · 0 comments

kerem commented

2026-02-28 00:04:04 +03:00

Owner

📋 Pull Request Information

Original PR: https://github.com/spotipy-dev/spotipy/pull/1185
Author: @dieser-niko
Created: 1/24/2025
Status: ✅ Merged
Merged: 2/2/2025
Merged by: @dieser-niko

Base: v3 ← Head: feature/docstring-improvement

📝 Commits (4)

76ad4a6 convert docstings to reStructuredText format for client.py
f312d7a convert docstings to reStructuredText format for cache_handler.py, exceptions.py, oauth2.py, scope.py, util.py
b5e1577 fix formatting and inconsistencies
1b83d2f add changelog

📊 Changes

7 files changed (+1040 additions, -784 deletions)

View changed files

📝 CHANGELOG.md (+1 -0)
📝 spotipy/cache_handler.py (+101 -28)
📝 spotipy/client.py (+616 -608)
📝 spotipy/exceptions.py (+25 -2)
📝 spotipy/oauth2.py (+277 -127)
📝 spotipy/scope.py (+10 -11)
📝 spotipy/util.py (+10 -8)

📄 Description

Currently there are two different types of docstrings being used and I only know one of them. Also RTD seems to be able to format RST better than the other format.

Using GitHub Copilot for that job and it seems to shorten a lot of descriptions, even when asked not to.
I'm still going to push these "mistakes" and I'll check afterwards if these changes make sense or not.

_{🔄 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/spotipy-dev/spotipy/pull/1185 **Author:** [@dieser-niko](https://github.com/dieser-niko) **Created:** 1/24/2025 **Status:** ✅ Merged **Merged:** 2/2/2025 **Merged by:** [@dieser-niko](https://github.com/dieser-niko) **Base:** `v3` ← **Head:** `feature/docstring-improvement` --- ### 📝 Commits (4) - [`76ad4a6`](https://github.com/spotipy-dev/spotipy/commit/76ad4a68f0a724808e5972945704a362bad254de) convert docstings to reStructuredText format for client.py - [`f312d7a`](https://github.com/spotipy-dev/spotipy/commit/f312d7a772215ddd3a143ace334d07ab57093efa) convert docstings to reStructuredText format for cache_handler.py, exceptions.py, oauth2.py, scope.py, util.py - [`b5e1577`](https://github.com/spotipy-dev/spotipy/commit/b5e157737aad81c57749e9efc5eaa7f09ff88784) fix formatting and inconsistencies - [`1b83d2f`](https://github.com/spotipy-dev/spotipy/commit/1b83d2f264f1c433f515dedcbada62c4b3d90111) add changelog ### 📊 Changes **7 files changed** (+1040 additions, -784 deletions) <details> <summary>View changed files</summary> 📝 `CHANGELOG.md` (+1 -0) 📝 `spotipy/cache_handler.py` (+101 -28) 📝 `spotipy/client.py` (+616 -608) 📝 `spotipy/exceptions.py` (+25 -2) 📝 `spotipy/oauth2.py` (+277 -127) 📝 `spotipy/scope.py` (+10 -11) 📝 `spotipy/util.py` (+10 -8) </details> ### 📄 Description Currently there are two different types of docstrings being used and I only know one of them. Also RTD seems to be able to format RST better than the other format. Using GitHub Copilot for that job and it seems to shorten a lot of descriptions, even when asked not to. I'm still going to push these "mistakes" and I'll check afterwards if these changes make sense or not. --- <sub>🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.</sub>