From 0d25bf7689cf11b9c3931341b0c60c84b9daa015 Mon Sep 17 00:00:00 2001 From: lowlighter <22963968+lowlighter@users.noreply.github.com> Date: Tue, 18 Jan 2022 12:43:17 -0500 Subject: [PATCH] docs(plugins): minor short description changes --- source/plugins/base/README.md | 4 ++-- source/plugins/base/metadata.yml | 4 ++-- source/plugins/licenses/README.md | 2 +- source/plugins/licenses/metadata.yml | 2 +- source/plugins/starlists/README.md | 8 +++++--- source/plugins/starlists/index.mjs | 1 - source/plugins/starlists/metadata.yml | 8 ++++++-- 7 files changed, 17 insertions(+), 12 deletions(-) diff --git a/source/plugins/base/README.md b/source/plugins/base/README.md index bf11be20..0b393d9d 100644 --- a/source/plugins/base/README.md +++ b/source/plugins/base/README.md @@ -137,8 +137,8 @@ Broad affiliation will result in less representative metrics.

commits_authoring -

Name, username, email addresses that has been used for authoring commits

-

This setting can be used to detect commits ownerships in some plugin

+

Identifiers that has been used for authoring commits

+

Specify names, surnames, username, email addresses that has been used in the past that can be used to detect commits ownerships in some plugins

diff --git a/source/plugins/base/metadata.yml b/source/plugins/base/metadata.yml index 014a6d2e..869773ec 100644 --- a/source/plugins/base/metadata.yml +++ b/source/plugins/base/metadata.yml @@ -96,9 +96,9 @@ inputs: commits_authoring: description: | - Name, username, email addresses that has been used for authoring commits + Identifiers that has been used for authoring commits - This setting can be used to detect commits ownerships in some plugin + Specify names, surnames, username, email addresses that has been used in the past that can be used to detect commits ownerships in some plugins type: array format: comma-seperated default: .user.login diff --git a/source/plugins/licenses/README.md b/source/plugins/licenses/README.md index 9524c9ac..93e2d745 100644 --- a/source/plugins/licenses/README.md +++ b/source/plugins/licenses/README.md @@ -83,7 +83,7 @@ Dependencies will be analyzed by [GitHub licensed](https://github.com/github/lic plugin_licenses_legal -

Display permissions, limitations and conditions about used licenses

+

Display permissions, limitations and conditions about licenses

diff --git a/source/plugins/licenses/metadata.yml b/source/plugins/licenses/metadata.yml index 182d5a51..9a4f317b 100644 --- a/source/plugins/licenses/metadata.yml +++ b/source/plugins/licenses/metadata.yml @@ -29,6 +29,6 @@ inputs: default: no plugin_licenses_legal: - description: Display permissions, limitations and conditions about used licenses + description: Display permissions, limitations and conditions about licenses type: boolean default: yes \ No newline at end of file diff --git a/source/plugins/starlists/README.md b/source/plugins/starlists/README.md index 5c5aad70..8fbbb9ad 100644 --- a/source/plugins/starlists/README.md +++ b/source/plugins/starlists/README.md @@ -81,7 +81,8 @@ plugin_starlists_ignored -

Skipped star lists (case insensitive, emojis insensitive)

+

Skipped star lists

+

This is case and emojis insensitive

@@ -92,8 +93,9 @@ plugin_starlists_only -

Restrict display to specified star lists (case insensitive, emojis insensitive)

-

This option is equivalent to plugin_starlists_ignored with all star lists but the ones listed in this option

+

Restrict display to specified star lists

+

This is case and emojis insensitive. +This option is equivalent to plugin_starlists_ignored with all star lists but the ones listed in this option

diff --git a/source/plugins/starlists/index.mjs b/source/plugins/starlists/index.mjs index 26362277..d4a34c43 100644 --- a/source/plugins/starlists/index.mjs +++ b/source/plugins/starlists/index.mjs @@ -30,7 +30,6 @@ export default async function({login, q, imports, data, account}, {enabled = fal )) const count = lists.length console.debug(`metrics/compute/${login}/plugins > starlists > found [${lists.map(({name}) => name)}]`) - console.log(">>>>> DEBUG", lists.map(({name}) => name), lists.map(({name}) => imports.stripemojis(name ?? "").trim().toLocaleLowerCase()), only, ignored) lists = lists .filter(({name}) => { name = imports.stripemojis(name ?? "").trim().toLocaleLowerCase() diff --git a/source/plugins/starlists/metadata.yml b/source/plugins/starlists/metadata.yml index c1d064e9..20378f48 100644 --- a/source/plugins/starlists/metadata.yml +++ b/source/plugins/starlists/metadata.yml @@ -34,7 +34,10 @@ inputs: default: yes plugin_starlists_ignored: - description: Skipped star lists (case insensitive, emojis insensitive) + description: | + Skipped star lists + + This is case and emojis insensitive type: array format: comma-separated default: "" @@ -42,8 +45,9 @@ inputs: plugin_starlists_only: description: | - Restrict display to specified star lists (case insensitive, emojis insensitive) + Restrict display to specified star lists + This is case and emojis insensitive. This option is equivalent to `plugin_starlists_ignored` with all star lists but the ones listed in this option type: array format: comma-separated