[GH-ISSUE #1118] API Reference Refers to Deprecated Methods #665

New issue

Closed

opened 2026-02-28 00:00:40 +03:00 by kerem · 2 comments

kerem commented

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

Owner

Originally created by @bartokay on GitHub (May 25, 2024).
Original GitHub issue: https://github.com/spotipy-dev/spotipy/issues/1118

Example:
https://spotipy.readthedocs.io/en/2.22.1/#spotipy.client.Spotify.artist_albums

artist_albums(artist_id, album_type=None, country=None, limit=20, offset=0)

The docs reference album_type, which has been deprecated and replaced with include_groups. This is noted in client.py, but include_groups is not mentioned in the docs at all.

This is just one example - I noticed similar inconsistencies with some other methods in client.py that have DeprecationWarnings. While some updated methods are documented, the deprecated versions should either be marked as deprecated in the docs or removed entirely.

Originally created by @bartokay on GitHub (May 25, 2024). Original GitHub issue: https://github.com/spotipy-dev/spotipy/issues/1118 Example: https://spotipy.readthedocs.io/en/2.22.1/#spotipy.client.Spotify.artist_albums ```artist_albums(artist_id, album_type=None, country=None, limit=20, offset=0)``` The docs reference ```album_type```, which has been deprecated and replaced with ```include_groups```. This is noted in ```client.py```, but ```include_groups``` is not mentioned in the docs at all. This is just one example - I noticed similar inconsistencies with some other methods in ```client.py``` that have DeprecationWarnings. While some updated methods are documented, the deprecated versions should either be marked as deprecated in the docs or removed entirely.

kerem

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

closed this issue
added the
documentation
label

kerem commented

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

Author

Owner

@dieser-niko commented on GitHub (May 27, 2024):

Docs weren't updating correctly. We're already working on a solution to prevent this from happening in the future.

@dieser-niko commented on GitHub (May 27, 2024): Docs weren't updating correctly. We're already working on a solution to prevent this from happening in the future.

kerem commented

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

Author

Owner

@dieser-niko commented on GitHub (May 30, 2024):

We have released a new version. The documentation should now also match the code. Here's a new link to the mentioned function: https://spotipy.readthedocs.io/en/2.24.0/#spotipy.client.Spotify.artist_albums

I'm closing the issue now, as I assume this has been resolved. You can of course reopen it if I missed something.

@dieser-niko commented on GitHub (May 30, 2024): We have released a new version. The documentation should now also match the code. Here's a new link to the mentioned function: https://spotipy.readthedocs.io/en/2.24.0/#spotipy.client.Spotify.artist_albums I'm closing the issue now, as I assume this has been resolved. You can of course reopen it if I missed something.

kerem referenced this issue

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

[PR #665] [MERGED] V3 #984

kerem referenced this issue

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

[PR #812] [CLOSED] Code of conduct.md addition. #1021

kerem referenced this issue

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

[PR #825] [CLOSED] Code of Conduct Contribution + Set up guide #1031

kerem referenced this issue

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

[PR #961] [MERGED] Codebase Refactor for v3 #1095