[PR #909] [CLOSED] Suggested update for online documentation and README.md #1074

New issue

Closed

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

kerem commented

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

Owner

📋 Pull Request Information

Original PR: https://github.com/spotipy-dev/spotipy/pull/909
Author: @jonmacia
Created: 12/1/2022
Status: ❌ Closed

Base: master ← Head: master

📝 Commits (10+)

fa0c668 Update index.rst
d07ddbc Update index.rst
9fe94d6 Update README.md
a20cd93 Update README.md
7be1575 Update README.md
337cb9c Update index.rst
0e6b8d3 Update README.md
94b452d Update index.rst
9e56abb Merge branch 'spotipy-dev:master' into master
0ae16d1 Update README.md

📊 Changes

3 files changed (+31 additions, -0 deletions)

View changed files

📝 CHANGELOG.md (+6 -0)
📝 README.md (+9 -0)
📝 docs/index.rst (+16 -0)

📄 Description

I added a "works in progress" section to both these files so a potential new user/contributor can quickly and easily find what in the documentation needs updated.
I added a section to the online documentation displaying information on what technical expertise is required for a new user/contributor. I also added a note explicitly informing a potential new user/contributor that this project is Open Source Software. I placed these additions towards the top of the page so the reader can quickly be informed on this.
I also made a title called ”An Example” for the example code given in the introduction of the homepage. This minor suggestion was to make the outline of this part of the online documentation more clear.

_{🔄 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/909 **Author:** [@jonmacia](https://github.com/jonmacia) **Created:** 12/1/2022 **Status:** ❌ Closed **Base:** `master` ← **Head:** `master` --- ### 📝 Commits (10+) - [`fa0c668`](https://github.com/spotipy-dev/spotipy/commit/fa0c668187ca03c4a3a65c7cd4162db0b45fe7ec) Update index.rst - [`d07ddbc`](https://github.com/spotipy-dev/spotipy/commit/d07ddbccbe22ed2c9f4cde5ff1576f4e6bfbc503) Update index.rst - [`9fe94d6`](https://github.com/spotipy-dev/spotipy/commit/9fe94d6fbba7350d5630939a8a0a7d96d68eb83c) Update README.md - [`a20cd93`](https://github.com/spotipy-dev/spotipy/commit/a20cd93570699d2c8adffb78abcd784445a36044) Update README.md - [`7be1575`](https://github.com/spotipy-dev/spotipy/commit/7be15756ea0afd698b91b1294675afb7605ae719) Update README.md - [`337cb9c`](https://github.com/spotipy-dev/spotipy/commit/337cb9c336d787da5e4fdece6460554dedfc9460) Update index.rst - [`0e6b8d3`](https://github.com/spotipy-dev/spotipy/commit/0e6b8d327768c0cd72d92f94e8f11e1950ed49bc) Update README.md - [`94b452d`](https://github.com/spotipy-dev/spotipy/commit/94b452df5db399ba60a58c50c9c718e9391f85dc) Update index.rst - [`9e56abb`](https://github.com/spotipy-dev/spotipy/commit/9e56abb01d5746a78b7e7759bde97327e461ee2b) Merge branch 'spotipy-dev:master' into master - [`0ae16d1`](https://github.com/spotipy-dev/spotipy/commit/0ae16d156ac3ca5539c6e3b8ee0220a6c2c6113f) Update README.md ### 📊 Changes **3 files changed** (+31 additions, -0 deletions) <details> <summary>View changed files</summary> 📝 `CHANGELOG.md` (+6 -0) 📝 `README.md` (+9 -0) 📝 `docs/index.rst` (+16 -0) </details> ### 📄 Description 1) I added a "works in progress" section to both these files so a potential new user/contributor can quickly and easily find what in the documentation needs updated. 2) I added a section to the online documentation displaying information on what technical expertise is required for a new user/contributor. I also added a note explicitly informing a potential new user/contributor that this project is Open Source Software. I placed these additions towards the top of the page so the reader can quickly be informed on this. 3) I also made a title called ”An Example” for the example code given in the introduction of the homepage. This minor suggestion was to make the outline of this part of the online documentation more clear. --- <sub>🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.</sub>