Skip to content

Commit 8d915c5

Browse files
fix: typos and correcting grammatical errors (#170)
* fixed typos and correct grammatical errors * fix: small changes --------- Co-authored-by: Afonso Jorge Ramos <afonsojorgeramos@gmail.com>
1 parent 72a33ce commit 8d915c5

29 files changed

+55
-55
lines changed

docs/advanced-usage/command-line-interface.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ Run with no command once to generate config file
99
spicetify
1010
```
1111

12-
If you just want to use Custom Apps and Extensions head over to each specific sections, if you want to create your own theme, keep reading below.
12+
If you just want to use Custom Apps and Extensions head over to each specific section, if you want to create your own theme, keep reading below.
1313

1414
Make sure config file is created successfully and there is no error, then run:
1515

docs/advanced-usage/custom-apps.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ spicetify apply
3131

3232
## Uninstalling
3333

34-
If you want to remove a custom app from the current list of custom app you can always append a `-` after the file name:
34+
If you want to remove a custom app from the current list of custom apps you can always append a `-` after the file name:
3535

3636
```bash
3737
spicetify config custom_apps <file name>-
@@ -71,7 +71,7 @@ Three apps have been included to demonstrate how to create and inject an app:
7171

7272
### Reddit
7373

74-
Fetching posts from any Spotify link sharing subreddit. You can add, remove, arrange subreddits and customize post visual in config menu (in Profile menu, top right button with your user name).
74+
Fetching posts from any Spotify link sharing subreddit. You can add, remove, arrange subreddits and customize post visual in config menu (in Profile menu, top right button with your username).
7575

7676
![Reddit](https://i.imgur.com/MC3tpNZ.png)
7777

@@ -84,7 +84,7 @@ spicetify apply
8484

8585
### New Releases
8686

87-
Aggregate all new releases from favorite artists, podcasts. Time range, release type, and other filters can be customized in config menu (in Profile menu, top right button with your user name). Date format is based on your locale code (BCP47).
87+
Aggregate all new releases from favorite artists, podcasts. Time range, release type, and other filters can be customized in config menu (in Profile menu, top right button with your username). Date format is based on your locale code (BCP47).
8888

8989
![New Releases](https://i.imgur.com/MP9dTjt.png)
9090

@@ -99,7 +99,7 @@ spicetify apply
9999

100100
Get access to the current track's lyrics from various lyrics providers (Musixmatch, Netease, LRCLIB). Learn more [here](https://github.com/spicetify/cli/tree/main/CustomApps/lyrics-plus).
101101

102-
Colors, lyrics providers can be customized in config menu (in Profile menu, top right button with your user name).
102+
Colors, lyrics providers can be customized in config menu (in Profile menu, top right button with your username).
103103

104104
![Lyrics Plus](https://i.imgur.com/WtD080A.png)
105105

docs/advanced-usage/installation.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -81,7 +81,7 @@ If Spotify is installed through the `spotify-launcher` package, then Spotify won
8181

8282
This directory will need to be added to the `spotify-path` section of the config (and you won't need to change any permissions like the AUR method).
8383

84-
**Note:** `spotify-path` must be an abslolute path. Do not use `~` to reference the home folder.
84+
**Note:** `spotify-path` must be an absolute path. Do not use `~` to reference the home folder.
8585

8686
#### Spotify installed from Snap
8787

@@ -96,7 +96,7 @@ echo "deb http://repository.spotify.com stable non-free" | sudo tee /etc/apt/sou
9696
sudo apt-get update && sudo apt-get install spotify-client
9797
```
9898

99-
4. After Spotify is installed successfully, you need to gain read write permissions on Spotify files, by running commands:
99+
3. After Spotify is installed successfully, you need to gain read write permissions on Spotify files, by running commands:
100100

101101
```bash
102102
sudo chmod a+wr /usr/share/spotify

docs/development/api-wrapper/classes/menu.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -59,7 +59,7 @@ setName(name: string): void
5959

6060
##### setState
6161

62-
Set the state of the menu item. The item would has a tick icon next to it if its state is enabled.
62+
Set the state of the menu item. The item will have a tick icon next to it if its state is enabled.
6363

6464
```ts
6565
setState(isEnabled: boolean): void

docs/development/api-wrapper/classes/topbar.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ namespace Topbar {
3030
| icon | [`SVGIcon`](/docs/development/api-wrapper/types/svgicon) &#124; `string` | Icon of the button. |
3131
| onClick | `(self: Button) => void` | Callback function when the button is clicked. |
3232
| disabled | `boolean` | Whether the button is disabled. |
33-
| isRight | `boolean` | Whether the button is button placed on right side. |
33+
| isRight | `boolean` | Whether the button is button placed on the right side. |
3434

3535
#### Properties
3636

docs/development/api-wrapper/functions/get-font-style.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ Spicetify provides a function that returns the CSS style for a given font varian
77

88
:::tip
99

10-
This function is used to provide backwards compatibility for older Spicetify extensions and custom apps that uses `main-type-` classes.
10+
This function is used to provide backwards compatibility for older Spicetify extensions and custom apps that use `main-type-` classes.
1111

1212
Instead of using this function to get Spotify stylings, you can simply add the `main-type-<variant>` class to your element.
1313

docs/development/api-wrapper/functions/remove-from-queue.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ This works similarly to [`Spicetify.Platform.PlayerAPI.removeFromQueue`](/docs/d
1111

1212
:::caution
1313

14-
If an `uid` is not provided, all tracks with the same `uri` will be removed.
14+
If a `uid` is not provided, all tracks with the same `uri` will be removed.
1515

1616
:::
1717

docs/development/api-wrapper/methods/app-title.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ Spicetify provides a set of API methods to interact with the Spotify client app
77

88
:::note
99

10-
These methods only works for default app title.
10+
These methods only work for the default app title.
1111

1212
:::
1313

@@ -24,7 +24,7 @@ namespace AppTitle {
2424

2525
### `set`
2626

27-
Set default app title and forces it until cancelled. This will override any previous forced title.
27+
Set the default app title and force it until canceled. This will override any previous forced title.
2828

2929
:::note
3030

docs/development/api-wrapper/methods/cosmos-async.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
11
---
22
title: CosmosAsync
3-
description: Asyncronous Cosmos API wrapper used by the Spotify client.
3+
description: Asynchronous Cosmos API wrapper used by the Spotify client.
44
---
55

6-
Asyncronous Cosmos API wrapper used by the Spotify client. It is used to make requests to the Spotify client's internal API as well as external URLs.
6+
Asynchronous Cosmos API wrapper used by the Spotify client. It is used to make requests to the Spotify client's internal API as well as external URLs.
77

88
```ts
99
Spicetify.CosmosAsync

docs/development/api-wrapper/methods/graphql.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -9,9 +9,9 @@ GraphQL API Wrapper used throughout the Spotify client. It is used to communicat
99

1010
Because this is a private API, it is not documented by Spotify. This documentation is based on the usage of the API in the Spotify client, and may not be accurate.
1111

12-
It is also subjected to drastic changes in the future, and has went through such changes in the past.
12+
It is also subject to drastic changes in the future, and has gone through such changes in the past.
1313

14-
Any issues or errors that arises from using this API is not the responsibility of this documentation. Use at your own risk.
14+
Any issues or errors that arise from using this API are not the responsibility of this documentation. If you want to take advantage of this API, bear this in mind.
1515

1616
:::
1717

@@ -266,7 +266,7 @@ This is the type of operation that you want to perform, and can be either `query
266266

267267
###### `name`
268268

269-
This is the name of the operation that you want to perform. Usually the name of the definition are self-explanatory, so you can be sure of what the operation does by looking at the name.
269+
This is the name of the operation that you want to perform. Usually the name of the definition is self-explanatory, so you can be sure of what the operation does by looking at the name.
270270

271271
###### `variableDefinitions`
272272

docs/development/api-wrapper/methods/keyboard.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ Spicetify provides its own method for global keyboard shortcuts. You can specify
77

88
:::tip
99

10-
`Spicetify.Keyboard` is wrapper of [`Spicetify.Mousetrap`](/docs/development/api-wrapper/modules#mousetrap) configured to be compatible with legacy Spotify.
10+
`Spicetify.Keyboard` is a wrapper of [`Spicetify.Mousetrap`](/docs/development/api-wrapper/modules#mousetrap) configured to be compatible with legacy Spotify.
1111

1212
New extensions are advised to use the module instead.
1313

docs/development/api-wrapper/methods/local-storage.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ Spicetify provides a wrapper for `localStorage` to make it easier to use.
77

88
:::tip
99

10-
All keys created via this method is generic and stored as-is.
10+
All keys created via this method are generic and stored as-is.
1111

1212
If you wish to store values that are specific for each user account, you can use [`Platform.LocalStorageAPI`](/docs/development/api-wrapper/methods/platform#localstorageapi) instead.
1313

docs/development/api-wrapper/methods/panel.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ title: Panel
33
description: API wrapper to interact with Spotify's panel/right sidebar.
44
---
55

6-
Spicetify provides a wrapper for Spotify `PanelAPI` method to make it easier to use, as well as providing a method to help you register your own panel.
6+
Spicetify provides a wrapper for the Spotify `PanelAPI` method to make it easier to use, as well as providing a method to help you register your own panel.
77

88
```ts
99
namespace Panel {
@@ -257,7 +257,7 @@ const PanelAction = () => {
257257
)
258258
}
259259

260-
// Ideally, you would want to memorize this component
260+
// Ideally, you would want to memoize this component
261261
// to prevent unnecessary re-renders if you were to pass props
262262

263263
// Props will have a single `panel` property for the panel ID

docs/development/api-wrapper/methods/platform.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ Because these APIs are internal, they are not guaranteed to be stable and may *d
1919

2020
## Usage
2121

22-
Since these APIs differ between each version of the Spotify client, we cannot provide a complete list of all available APIs. Instead, we provide a list of APIs that may prove useful for extension developers and generally hasn't changed much over the years.
22+
Since these APIs differ between each version of the Spotify client, we cannot provide a complete list of all available APIs. Instead, we provide a list of APIs that may prove useful for extension developers and that have generally not changed much over the years.
2323

2424
:::note
2525

docs/development/api-wrapper/methods/player.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -167,7 +167,7 @@ Spicetify.Player.decreaseVolume();
167167

168168
### formatTime
169169

170-
Format a time in milisecond to a string in `mm:ss` format.
170+
Format a time in milliseconds to a string in `mm:ss` format.
171171

172172
```ts
173173
Spicetify.Player.formatTime(time);
@@ -177,7 +177,7 @@ Spicetify.Player.formatTime(time);
177177

178178
| Name | Type | Description |
179179
| ---- | ---- | ----------- |
180-
| `time` | `number` | Time in milisecond |
180+
| `time` | `number` | Time in milliseconds |
181181

182182
#### Return
183183

@@ -196,7 +196,7 @@ console.log(formattedDuration); // "03:45"
196196

197197
### getDuration
198198

199-
Return the duration of current track in milisecond.
199+
Return the duration of current track in milliseconds.
200200

201201
```ts
202202
Spicetify.Player.getDuration();
@@ -228,7 +228,7 @@ Spicetify.Player.getMute();
228228

229229
### getProgress
230230

231-
Return the progress of current track in milisecond.
231+
Return the progress of current track in milliseconds.
232232

233233
```ts
234234
Spicetify.Player.getProgress();
@@ -392,7 +392,7 @@ Spicetify.Player.removeEventListener(type, callback);
392392

393393
### seek
394394

395-
Seek track to position. Position can be in percentage (0 to 1) or in milisecond.
395+
Seek track to position. Position can be in percentage (0 to 1) or in milliseconds.
396396

397397
```ts
398398
Spicetify.Player.seek(position);
@@ -402,7 +402,7 @@ Spicetify.Player.seek(position);
402402

403403
| Name | Type | Description |
404404
| ---- | ---- | ----------- |
405-
| `position` | `number` | Position to seek. Can be in percentage (0 to 1) or in milisecond |
405+
| `position` | `number` | Position to seek. Can be in percentage (0 to 1) or in milliseconds |
406406

407407
#### Example
408408

docs/development/api-wrapper/methods/popup-modal.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ namespace PopupModal {
2222

2323
### `Content`
2424

25-
`Content` is an object that contains information about the modal needs to be displayed.
25+
`Content` is an object that contains the information needed to display the modal.
2626

2727
| Property | Type | Description |
2828
| --- | --- | --- |

docs/development/api-wrapper/methods/uri.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -304,7 +304,7 @@ For a list of all validation functions, see [`Validation functions`](/docs/devel
304304

305305
:::caution
306306

307-
Almost all playlists uses the `playlist-v2` type, so use `Spicetify.URI.isPlaylistV2URI` instead.
307+
Almost all playlists use the `playlist-v2` type, so use `Spicetify.URI.isPlaylistV2URI` instead.
308308

309309
Similarly, you can use `Spicetify.URI.isPlaylistV1OrV2` to check if a URI is a playlist of any version.
310310

docs/development/api-wrapper/modules.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -47,7 +47,7 @@ Spicetify.Tippy;
4747

4848
### Mousetrap
4949

50-
[Mousetrap](https://craig.is/killing/mice) is a simple library for handling keyboard shortcuts in Javascript.
50+
[Mousetrap](https://craig.is/killing/mice) is a simple library for handling keyboard shortcuts in JavaScript.
5151

5252
```js
5353
Spicetify.Mousetrap;

docs/development/api-wrapper/properties/config.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -35,4 +35,4 @@ if (Config.custom_apps.includes("lyrics-plus")) {
3535
}
3636
```
3737

38-
This can ensure that your extension doesn't break if the user doesn't have the requried app or theme installed.
38+
This can ensure that your extension doesn't break if the user doesn't have the required app or theme installed.

docs/development/api-wrapper/types/player-state.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -66,7 +66,7 @@ type PlayerState = {
6666
| Property | Type | Description |
6767
| --- | --- | --- |
6868
| `timestamp` | `number` | Timestamp. |
69-
| `context_uri` | `string` | Context URI from which the track played from. |
69+
| `context_uri` | `string` | Context URI from which the track was played. |
7070
| `context_url` | `string` | Context internal URL. |
7171
| `context_restrictions` | `Record<string, string[]>` | Context restrictions. |
7272
| `index` | `object` &#124; `undefined` | Track index. |

docs/development/custom-apps.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ description: 🔧 Creating Custom Apps.
1717
- `icon`: The escaped SVG markup for the sidebar icon.
1818
- `active-icon`: The escaped SVG markup for the active status of the sidebar icon (when your custom app is open).
1919
- `subfiles`: You can optionally include other JS files. These files will be concatenated together in the order defined here. Any variables you declare in the main `index.js`, or any subfiles will be accessible from all. This is useful for organizational purposes for more complex custom apps.
20-
- `subfiles_extension`: You can optionally include an extension(s) with your custom app. These are treated as regular extensions, and will run when Spotify starts.
20+
- `subfiles_extension`: You can optionally include one or more extensions with your custom app. These are treated as regular extensions, and will run when Spotify starts.
2121

2222
_Note: The `subfiles` can be in nested folders, while any `subfiles_extension` can not._
2323

docs/development/js-modules.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ Since v0.9.8, Spicetify injects extension with file extension `.mjs` as a script
77

88
In Javascript module, Javascript would work just the same as normal script but now you can use `import` to include other Javascript files. [Click here for details](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Modules).
99

10-
Node Package Manager (NPM) is a commandline app bundled with NodeJS. You can it use to download and install hundred of utilities packages to ease your development process. Since Spicetify symlinks `node_modules` to Spotify main app folder, all packages files are mutually linked and available for you to use in your extension. Simply just use `import`:
10+
Node Package Manager (NPM) is a commandline app bundled with NodeJS. You can use it to download and install hundreds of utility packages to ease your development process. Since Spicetify symlinks `node_modules` to Spotify main app folder, all packages files are mutually linked and available for you to use in your extension. Simply just use `import`:
1111

1212
```js
1313
import './node_modules/package_name/file.js';
@@ -17,7 +17,7 @@ Careful! Javascript file you import has to be supported by Browser, not NodeJS.
1717

1818
### Example
1919

20-
For Japanese studying purpose, I'm developing an extension that show Romaji form of Japanese track titles or artist names.
20+
For Japanese studying purpose, I'm developing an extension that shows the Romaji form of Japanese track titles or artist names.
2121

2222
The idea is when I right click at track name and choose Show Romaji:
2323

@@ -27,11 +27,11 @@ Result should show as a notification:
2727

2828
![img2](https://i.imgur.com/LLF5ZGh.png)
2929

30-
To translate Japanese text to Romaji, I use a package named [kuroshiro](https://github.com/hexenq/kuroshiro). Luckily, this package will export distribution files as ES6 Module. This is quite important because package itself relies on other utilities packages too. When it is complied as ES6 Module, everything is transpiled to Browser supported Javascript and combined in one file. Moreover, kuroshiro also needs [kuroshiro-analyzer-kuromoji](https://github.com/hexenq/kuroshiro-analyzer-kuromoji) package to be usable, which relies on dictionaries gzip files. You can see there is no easy way to utiltise both packages and their external files if we use traditional Javascript extension.
30+
To translate Japanese text to Romaji, I use a package named [kuroshiro](https://github.com/hexenq/kuroshiro). Luckily, this package will export distribution files as ES6 Module. This is quite important because package itself relies on other utilities packages too. When it is compiled as an ES6 module, everything is transpiled to Browser supported Javascript and combined in one file. Moreover, kuroshiro also needs [kuroshiro-analyzer-kuromoji](https://github.com/hexenq/kuroshiro-analyzer-kuromoji) package to be usable, which relies on dictionaries gzip files. You can see there is no easy way to utiltise both packages and their external files if we use traditional Javascript extension.
3131

3232
**Following are steps to make and install this extension from scratch:**
3333

34-
1. First, change director to user's `Extensions` folder:
34+
1. First, change director to the user's `Extensions` folder:
3535

3636
- **Windows, in Powershell:**
3737

@@ -51,7 +51,7 @@ cd "$(dirname "$(spicetify -c)")/Extensions"
5151
npm install kuroshiro kuroshiro-analyzer-kuromoji
5252
```
5353

54-
Go to user's `Extensions` folder, you can see `node_modules` folder is created and contains all installed packages files. Next, go to `kuroshiro` and `kuroshiro-analyzer-kuromoji`folder to locate ES6 Module distribution files.
54+
Go to user's `Extensions` folder, you can see `node_modules` folder is created and contains all installed packages files. Next, go to the `kuroshiro` and `kuroshiro-analyzer-kuromoji`folder to locate ES6 Module distribution files.
5555

5656
3. After that I can comfortably include both of them in my extension. Following is extension code:
5757

docs/development/react-devtools.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ description: Installing and using React Developer Tools in Spotify.
55

66
To install React Developer Tools in Spotify:
77

8-
1. Launch Spotify in the developer mode (and with the `--enable-chrome-runtime` flag if you are using **Spotify older than 1.2.34**; without it React Developer Tools won't work)
8+
1. Launch Spotify in the developer mode (and with the `--enable-chrome-runtime` flag if you are using **Spotify versions older than 1.2.34**; without it, React Developer Tools won't work)
99
2. Press *Ctrl + Shift + T*
1010
3. Press *Ctrl + N*
1111
4. Navigate to the React Developer Tools page on Chrome Web Store using the address bar: `https://chromewebstore.google.com/detail/react-developer-tools/fmkadmapgofadopljbjfkapdkoienihi`

docs/development/spicetify-creator/create-custom-apps.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ description: 🔧 Creating single-page apps for Spicetify.
66
Notes:
77

88
- It is recommended to learn React before starting to create Custom Apps.
9-
- This tutorial assumes you chose to generate an example in Create Spicetify App.
9+
- This tutorial assumes you have chosen to generate an example using Create Spicetify App.
1010

1111
After creating a new Spicetify Creator project and choosing "Custom App" as your app's type, your project's structure should look like this (With the generated example):
1212

@@ -24,7 +24,7 @@ my-app/
2424
...
2525
```
2626

27-
For now, we only care about the `src/` folder, which structure looks like this
27+
For now, we only care about the `src/` folder, whose structure looks like this
2828

2929
```
3030
src/

docs/development/spicetify-creator/create-extensions.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ description: 🔨 Creating small addons for Spicetify.
55

66
Notes:
77

8-
- This tutorial assumes you chose to generate an example in Create Spicetify App.
8+
- This tutorial assumes you have chosen to generate an example using Create Spicetify App.
99

1010
After creating a new Spicetify Creator project and choosing "Extension" as your app's type, your project's structure should look like this (With the generated example):
1111

@@ -23,7 +23,7 @@ my-app/
2323
...
2424
```
2525

26-
For now, we only care about the `src/` folder, which structure looks like this
26+
For now, we only care about the `src/` folder, whose structure looks like this
2727

2828
```
2929
src/

0 commit comments

Comments
 (0)