From 32ec63b7c32a7736ad999336aa2c8392e4141386 Mon Sep 17 00:00:00 2001 From: mrjvs Date: Wed, 27 Sep 2023 20:51:54 +0200 Subject: [PATCH] Review suggestions --- .docs/content/2.Api/1.ProviderControlsRunAll.md | 2 +- .docs/content/2.Api/4.ProviderControlslistSources.md | 2 +- .docs/content/2.Api/5.ProviderControlslistEmbeds.md | 2 +- .docs/content/2.Api/6.ProviderControlsgetMetadata.md | 2 +- 4 files changed, 4 insertions(+), 4 deletions(-) diff --git a/.docs/content/2.Api/1.ProviderControlsRunAll.md b/.docs/content/2.Api/1.ProviderControlsRunAll.md index 8cc821b..7633381 100644 --- a/.docs/content/2.Api/1.ProviderControlsRunAll.md +++ b/.docs/content/2.Api/1.ProviderControlsRunAll.md @@ -1,6 +1,6 @@ # `ProviderControls.runAll` -Run all providers one by one in order of their builtin ranking. +Run all providers one by one in order of their built-in ranking. You can attach events if you need to know what is going on while its processing. ## Example diff --git a/.docs/content/2.Api/4.ProviderControlslistSources.md b/.docs/content/2.Api/4.ProviderControlslistSources.md index ef98a91..4489028 100644 --- a/.docs/content/2.Api/4.ProviderControlslistSources.md +++ b/.docs/content/2.Api/4.ProviderControlslistSources.md @@ -7,7 +7,7 @@ They are sorted by rank, highest first ```ts const sourceScrapers = providers.listSources(); -// garuanteed to only return type: 'source' +// Guaranteed to only return type: 'source' ``` ## Type diff --git a/.docs/content/2.Api/5.ProviderControlslistEmbeds.md b/.docs/content/2.Api/5.ProviderControlslistEmbeds.md index 067fe9d..6c69772 100644 --- a/.docs/content/2.Api/5.ProviderControlslistEmbeds.md +++ b/.docs/content/2.Api/5.ProviderControlslistEmbeds.md @@ -7,7 +7,7 @@ They are sorted by rank, highest first ```ts const embedScrapers = providers.listEmbeds(); -// garuanteed to only return type: 'embed' +// Guaranteed to only return type: 'embed' ``` ## Type diff --git a/.docs/content/2.Api/6.ProviderControlsgetMetadata.md b/.docs/content/2.Api/6.ProviderControlsgetMetadata.md index 550db4b..8a83f00 100644 --- a/.docs/content/2.Api/6.ProviderControlsgetMetadata.md +++ b/.docs/content/2.Api/6.ProviderControlsgetMetadata.md @@ -1,7 +1,7 @@ # `ProviderControls.getMetadata` Get meta data for a scraper, can be either source or embed scraper. -Returns null if id is not recognized. +Returns null if the `id` is not recognized. ## Example