Skip to content

Spotify: Update README#39

Merged
clarkd merged 2 commits intomainfrom
jame2O-issue35
Apr 17, 2026
Merged

Spotify: Update README#39
clarkd merged 2 commits intomainfrom
jame2O-issue35

Conversation

@jame2O
Copy link
Copy Markdown
Contributor

@jame2O jame2O commented Apr 15, 2026

Update Spotify README: Added information about required Redirect URI.

Switch to the Preview tab above and select the appropriate PR template to use for this change:

Update Spotify README: Added information about required Redirect URI.
@jame2O jame2O requested a review from clarkd April 15, 2026 08:47
Comment thread plugins/Spotify/v1/docs/README.md
Comment thread plugins/Spotify/v1/docs/README.md Outdated
# Before you start
To use the Spotify data source, you will need to create an application via the Spotify Developer portal. [Learn more](https://developer.spotify.com/documentation/web-api/tutorials/getting-started#create-an-app).
To use the Spotify data source, you will need to create an application via the Spotify Developer portal. [Learn more](https://developer.spotify.com/documentation/web-api/tutorials/getting-started#create-an-app).
You will need to specify a **Redirect URI** in order to setup your application. Please copy your desired URL from the following:
Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🟡 Line 3 uses "setup" as a verb ("in order to setup your application"), but "setup" is a noun/adjective — the correct verb form is "set up" (two words). Change it to "in order to set up your application".

Extended reasoning...

What the bug is

The newly added line reads: "You will need to specify a Redirect URI in order to setup your application." Here, "setup" is used as a verb, but in standard English "setup" functions as a noun or adjective (e.g., "the setup process", "a setup guide"). The correct verb form requires two separate words: "set up".

The specific code location

The error appears in plugins/Spotify/v1/docs/README.md at line 3 in the newly added text introduced by this PR.

Why it is a real error and not a style preference

The distinction between "setup" (noun/adjective) and "set up" (verb phrase) is a grammatical rule in standard English, not a stylistic choice. Dictionaries and style guides consistently treat "setup" as a one-word compound noun/adjective, while the verb usage requires two words. Using them interchangeably is a grammatical error.

Impact

The impact is minor — this is documentation text, and readers will generally understand the intent. However, it does reflect poorly on documentation quality, particularly in user-facing setup guides.

How to fix it

Simply change "setup" to "set up" on line 3.

Before: "in order to setup your application"
After: "in order to set up your application"

Step-by-step proof

  1. The full sentence reads: "You will need to specify a Redirect URI in order to setup your application."
  2. The word "setup" here is being used as a verb (the action of configuring the application).
  3. Test: substituting a synonym confirms it is a verb — "in order to configure your application" works correctly, proving "setup" here is acting as a verb.
  4. Since "setup" is not a valid verb form in standard English, this is a grammar error.
  5. The correct two-word verb phrase "set up" should be used: "in order to set up your application."

@jame2O jame2O added the documentation Improvements or additions to documentation label Apr 15, 2026
@github-actions
Copy link
Copy Markdown

🧩 Plugin PR Summary

📦 Modified Plugins

  • plugins/Spotify/v1

📋 Results

Step Status
Validation ✅ Passed
Deployment 🚀 Deployed

🔍 Validation Details

spotify
{
  "valid": true,
  "pluginName": "spotify",
  "pluginType": "cloud",
  "summary": {
    "Data Streams": 6,
    "Import Definitions": 0,
    "UI Configuration": true,
    "Has Icon": true,
    "Has Default Content": true,
    "Config Validation": false,
    "Custom Types": false
  }
}

@clarkd clarkd merged commit 236204c into main Apr 17, 2026
1 check passed
@clarkd clarkd deleted the jame2O-issue35 branch April 17, 2026 09:36
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Development

Successfully merging this pull request may close these issues.

2 participants