[PR #1130] [MERGED] Added and revised function docstrings for util.py #1171

New issue

Closed

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

kerem commented

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

Owner

📋 Pull Request Information

Original PR: https://github.com/spotipy-dev/spotipy/pull/1130
Author: @dianna-SE
Created: 6/6/2024
Status: ✅ Merged
Merged: 6/18/2024
Merged by: @dieser-niko

Base: master ← Head: util-function-docstrings

📝 Commits (3)

6ef01c4 Added and revised function docstrings for util.py
9acadbe added credentials to gitignore
7553bd2 Addressed request changes by reverting/modifying function docstrings to match the format used in client.py

📊 Changes

2 files changed (+27 additions, -15 deletions)

View changed files

📝 CHANGELOG.md (+1 -0)
📝 spotipy/util.py (+26 -15)

📄 Description

Description of PR
This pull request adds function docstrings that include arguments, returns and raises according to standard styling guidelines for Python. The prompt_for_user_token function docstring is revised for clarity -- credits to dieser-niko for the helpful explanation of these functions. It addresses issue #1115. This is a new and updated PR of a previous issue that I closed due to complications and commit issues.

Changes

Added docstrings to 'get_host_port()', 'normalize_scope()', and revised docstring for "prompt_for_user_token()".
Fixed several lines that were too long.
Updated CHANGELOG.md with documentation updates to the 'util.py' file.

Additional Context
I previously submitted a pull request that I decided to close due to complications with the commit history and incorrect implementation. I decided to create a new pull request with a more accurate implementation.

I am new to open-source contributions so I really appreciate any feedback to help me improve!

_{🔄 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/1130 **Author:** [@dianna-SE](https://github.com/dianna-SE) **Created:** 6/6/2024 **Status:** ✅ Merged **Merged:** 6/18/2024 **Merged by:** [@dieser-niko](https://github.com/dieser-niko) **Base:** `master` ← **Head:** `util-function-docstrings` --- ### 📝 Commits (3) - [`6ef01c4`](https://github.com/spotipy-dev/spotipy/commit/6ef01c4b3246d181d5f854cd385310414f09602c) Added and revised function docstrings for util.py - [`9acadbe`](https://github.com/spotipy-dev/spotipy/commit/9acadbe903e46f5f1f52447e4301a469f257ad7f) added credentials to gitignore - [`7553bd2`](https://github.com/spotipy-dev/spotipy/commit/7553bd273833fa26d8d6f3178487acabd5416f3b) Addressed request changes by reverting/modifying function docstrings to match the format used in client.py ### 📊 Changes **2 files changed** (+27 additions, -15 deletions) <details> <summary>View changed files</summary> 📝 `CHANGELOG.md` (+1 -0) 📝 `spotipy/util.py` (+26 -15) </details> ### 📄 Description **Description of PR** This pull request adds function docstrings that include arguments, returns and raises according to standard styling guidelines for Python. The prompt_for_user_token function docstring is revised for clarity -- credits to dieser-niko for the helpful explanation of these functions. It addresses issue #1115. This is a new and updated PR of a previous issue that I closed due to complications and commit issues. **Changes** - Added docstrings to 'get_host_port()', 'normalize_scope()', and revised docstring for "prompt_for_user_token()". - Fixed several lines that were too long. - Updated CHANGELOG.md with documentation updates to the 'util.py' file. **Additional Context** I previously submitted a pull request that I decided to close due to complications with the commit history and incorrect implementation. I decided to create a new pull request with a more accurate implementation. I am new to open-source contributions so I really appreciate any feedback to help me improve! --- <sub>🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.</sub>