[docs] less inline and simplified comments

ToshY · Nov 19, 2024 · 3d59de5 · 3d59de5
1 parent 97fe811
commit 3d59de5
Show file tree

Hide file tree

Showing 5 changed files with 5 additions and 10 deletions.
diff --git a/docs/base-api.md b/docs/base-api.md
@@ -14,12 +14,11 @@ require 'vendor/autoload.php';
 use ToshY\BunnyNet\BaseAPI;
 use ToshY\BunnyNet\Client\BunnyClient;
 
-// Create a BunnyClient using any HTTP client implementing "Psr\Http\Client\ClientInterface".
 $bunnyClient = new BunnyClient(
     client: new \Symfony\Component\HttpClient\Psr18Client(),
 );
 
-// Provide the API key available at the "Account Settings > API" section.
+// Provide the account API key.
 $baseApi = new BaseAPI(
     apiKey: '2cebf4f8-4bff-429f-86f6-bce2c2163d7e89fb0a86-a1b2-463c-a142-11eba8811989',
     client: $bunnyClient,

diff --git a/docs/edge-scripting-api.md b/docs/edge-scripting-api.md
@@ -12,12 +12,11 @@ require 'vendor/autoload.php';
 use ToshY\BunnyNet\EdgeScriptingAPI;
 use ToshY\BunnyNet\Client\BunnyClient;
 
-// Create a BunnyClient using any HTTP client implementing "Psr\Http\Client\ClientInterface".
 $bunnyClient = new BunnyClient(
     client: new \Symfony\Component\HttpClient\Psr18Client(),
 );
 
-// Provide the API key available at the "Account Settings > API" section.
+// Provide the account API key.
 $edgeScriptingApi = new EdgeScriptingAPI(
     apiKey: '2cebf4f8-4bff-429f-86f6-bce2c2163d7e89fb0a86-a1b2-463c-a142-11eba8811989',
     client: $bunnyClient,

diff --git a/docs/edge-storage-api.md b/docs/edge-storage-api.md
@@ -13,12 +13,11 @@ use ToshY\BunnyNet\Client\BunnyClient;
 use ToshY\BunnyNet\EdgeStorageAPI;
 use ToshY\BunnyNet\Enum\Region;
 
-// Create a BunnyClient using any HTTP client implementing "Psr\Http\Client\ClientInterface".
 $bunnyClient = new BunnyClient(
     client: new \Symfony\Component\HttpClient\Psr18Client(),
 );
 
-// Provide the "(Read-Only) Password" available at the "FTP & API Access" section of your specific storage zone.
+// Provide the password of the specific storage zone.
 $edgeStorageApi = new EdgeStorageAPI(
     apiKey: '6bf3d93a-5078-4d65-a437-501c44576fe6',
     client: $bunnyClient,

diff --git a/docs/logging-api.md b/docs/logging-api.md
@@ -19,12 +19,11 @@ require 'vendor/autoload.php';
 use ToshY\BunnyNet\Client\BunnyClient;
 use ToshY\BunnyNet\LoggingAPI;
 
-// Create a BunnyClient using any HTTP client implementing "Psr\Http\Client\ClientInterface".
 $bunnyClient = new BunnyClient(
     client: new \Symfony\Component\HttpClient\Psr18Client(),
 );
 
-// Provide the API key available at the "Account Settings > API" section.
+// Provide the account API key.
 $loggingApi = new LoggingAPI(
     apiKey: '2cebf4f8-4bff-429f-86f6-bce2c2163d7e89fb0a86-a1b2-463c-a142-11eba8811989',
     client: $bunnyClient,

diff --git a/docs/stream-api.md b/docs/stream-api.md
@@ -12,12 +12,11 @@ require 'vendor/autoload.php';
 use ToshY\BunnyNet\Client\BunnyClient;
 use ToshY\BunnyNet\StreamAPI;
 
-// Create a BunnyClient using any HTTP client implementing "Psr\Http\Client\ClientInterface".
 $bunnyClient = new BunnyClient(
     client: new \Symfony\Component\HttpClient\Psr18Client()
 );
 
-// Provide the "API key" available at the "API > API Key" section of your specific video library.
+// Provide the specific video library API key.
 $streamApi = new StreamAPI(
     apiKey: '710d5fb6-d923-43d6-87f8-ea65c09e76dc',
     client: $bunnyClient