fix(docs): lot of misspelling (#1180) [skip ci]

This commit is contained in:
Josh Soref
2022-08-14 12:04:03 -04:00
committed by GitHub
parent e2f27e931d
commit ab85858528
59 changed files with 115 additions and 115 deletions

View File

@@ -53,10 +53,10 @@ Be sure to read [contribution guide](/CONTRIBUTING.md) and [architecture](/ARCHI
Please respect the following guidelines:
- A plugin should be independant and should not rely on other plugins
- A plugin should be independent and should not rely on other plugins
- [🧱 core](/source/plugins/core/README.md) and [🗃️ base](/source/plugins/base/README.md) output can be reused though
- A plugin should never edit its original arguments, as it is shared amongst other plugins and would create unattended side effects
- Use `imports.metadata.plugins.{plugin-name}.inputs()` to automatically typecheck and default user inputs through defined `metadata.yml`
- Use `imports.metadata.plugins.{plugin-name}.inputs()` to automatically type check and default user inputs through defined `metadata.yml`
- Plugin options should respect the "lexical field" of existing option to keep consistency
- Plugin errors should be handled gracefully by partials with error message
- New dependencies should be avoided, consider using existing `imports`
@@ -229,7 +229,7 @@ export default async function(
{
login, //GitHub username
q, //Raw user inputs (dot notation without plugin_ prefix, don't use it directly)
imports, //Various utilitaires (axios, puppeteer, fs, etc., see /source/app/metrics/utils.mjs)
imports, //Various utilities (axios, puppeteer, fs, etc., see /source/app/metrics/utils.mjs)
data, //Raw data from core/base plugin
computed, //Computed data from core/base plugin
rest, //Rest authenticated GitHub octokit

View File

@@ -92,7 +92,7 @@ Tap "Copy to Clipboard"
It should result in something like `Haha, check out the places I've pooped on Poop Map https://api.poopmap.net/map?token=xxxxxxxxxx` copied.
Extract the `token` query paramater from the link and use it in `plugin_poopmap_token`.
Extract the `token` query parameter from the link and use it in `plugin_poopmap_token`.
This token will not expire and it will be able to access only public details.
## Examples workflows

View File

@@ -21,7 +21,7 @@ export default async function({login, q, imports, data, account}, {enabled = fal
headers: {"x-rapidapi-key": token},
})
//Query API for sotck charts
//Query API for stock charts
console.debug(`metrics/compute/${login}/plugins > stock > querying api for stock`)
const {data: {chart: {result: [{meta, timestamp, indicators: {quote: [{close}]}}]}}} = await imports.axios.get("https://yh-finance.p.rapidapi.com/stock/v2/get-chart", {
params: {interval, symbol, range: duration, region: "US"},