[PR #895] Add parameter type hinting to API reference #1063

New issue

Open

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

kerem commented

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

Owner

📋 Pull Request Information

Original PR: https://github.com/spotipy-dev/spotipy/pull/895
Author: @kevinsekuj
Created: 11/26/2022
Status: 🔄 Open

Base: master ← Head: add-doc-type-hints

📝 Commits (5)

2ac607f Add parameter type hinting to API reference
29357f9 Add parameter type hinting to API reference
8a054f8 Update changelog
d757ca5 Fix code style with autopep8
31ccbcd Fix flake8 errors

📊 Changes

3 files changed (+491 additions, -569 deletions)

View changed files

📝 CHANGELOG.md (+2 -0)
📝 docs/conf.py (+15 -14)
📝 spotipy/client.py (+474 -555)

📄 Description

Added basic built-in type hints to client.py methods
Modified docstrings of all methods with parameters from the form

            Parameters:
                - result - a previously returned paged result

:param result: a previously returned paged result

Added sphinx-autodoc-typehints package to automatically build documentation based on type annotations in client.py

Example:

_{🔄 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/895 **Author:** [@kevinsekuj](https://github.com/kevinsekuj) **Created:** 11/26/2022 **Status:** 🔄 Open **Base:** `master` ← **Head:** `add-doc-type-hints` --- ### 📝 Commits (5) - [`2ac607f`](https://github.com/spotipy-dev/spotipy/commit/2ac607f360cebd070cfce57c9d43e0373be81632) Add parameter type hinting to API reference - [`29357f9`](https://github.com/spotipy-dev/spotipy/commit/29357f96564ac6314ac7944b9e1c77bc48a00779) Add parameter type hinting to API reference - [`8a054f8`](https://github.com/spotipy-dev/spotipy/commit/8a054f8024c11600eaa750b56d60ebaca7dd3ffa) Update changelog - [`d757ca5`](https://github.com/spotipy-dev/spotipy/commit/d757ca5efd7b6b76caa0f1366a611820629b0e9a) Fix code style with autopep8 - [`31ccbcd`](https://github.com/spotipy-dev/spotipy/commit/31ccbcd93931dbcfa1ca9f0287e6aa09136f16fd) Fix flake8 errors ### 📊 Changes **3 files changed** (+491 additions, -569 deletions) <details> <summary>View changed files</summary> 📝 `CHANGELOG.md` (+2 -0) 📝 `docs/conf.py` (+15 -14) 📝 `spotipy/client.py` (+474 -555) </details> ### 📄 Description - Added basic built-in type hints to `client.py` methods - Modified docstrings of all methods with parameters from the form ``` Parameters: - result - a previously returned paged result ``` to ``` :param result: a previously returned paged result ``` - Added [sphinx-autodoc-typehints](https://github.com/tox-dev/sphinx-autodoc-typehints) package to automatically build documentation based on type annotations in `client.py` Example: ![image](https://user-images.githubusercontent.com/68984611/204113160-55843710-1300-455f-815b-88447655ff8b.png) --- <sub>🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.</sub>