[GH-ISSUE #819] README file: Beginner Friendly #508

Closed
opened 2026-02-27 23:23:01 +03:00 by kerem · 2 comments
Owner

Originally created by @Moorehar on GitHub (Jun 4, 2022).
Original GitHub issue: https://github.com/spotipy-dev/spotipy/issues/819

After taking a look at the software presented, there were a few moments in the README that left me befuddled. Though I was able to problem solve my way forward, I know that there are others out there who would become frustrated before finding the solution.

Attached to this bug report is my proposal of an edited version of the Spotipy README file which adds more descriptors about what different links do as well as keeps track of what the most important factors of getting set up with the software are.

Spotipy README edit.pdf

Originally created by @Moorehar on GitHub (Jun 4, 2022). Original GitHub issue: https://github.com/spotipy-dev/spotipy/issues/819 After taking a look at the software presented, there were a few moments in the README that left me befuddled. Though I was able to problem solve my way forward, I know that there are others out there who would become frustrated before finding the solution. Attached to this bug report is my proposal of an edited version of the Spotipy README file which adds more descriptors about what different links do as well as keeps track of what the most important factors of getting set up with the software are. [Spotipy README edit.pdf](https://github.com/plamere/spotipy/files/8838546/Spotipy.README.edit.pdf)
kerem 2026-02-27 23:23:01 +03:00
  • closed this issue
  • added the
    bug
    label
Author
Owner

@stephanebruckert commented on GitHub (Jun 18, 2022):

Please open a PR and we can review this together. So far your proposition looks good to me! Be aware others are also trying to improve the doc, such as in this PR https://github.com/plamere/spotipy/pull/823

<!-- gh-comment-id:1159578851 --> @stephanebruckert commented on GitHub (Jun 18, 2022): Please open a PR and we can review this together. So far your proposition looks good to me! Be aware others are also trying to improve the doc, such as in this PR https://github.com/plamere/spotipy/pull/823
Author
Owner

@stephanebruckert commented on GitHub (Oct 29, 2022):

Fixed by https://github.com/plamere/spotipy/pull/872

<!-- gh-comment-id:1295835479 --> @stephanebruckert commented on GitHub (Oct 29, 2022): Fixed by https://github.com/plamere/spotipy/pull/872
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/spotipy#508
No description provided.