Skip to content

Add descriptions

Add descriptions #1559

GitHub Actions / LanguageTool completed Sep 16, 2024 in 1s

reviewdog [LanguageTool] report

reported by reviewdog 🐶

Findings (1)

docs/modules/hive/pages/getting_started/first_steps.adoc|4 col 181| In American English, ‘afterward’ is the preferred variant. ‘Afterwards’ is more commonly used in British English and other dialects. (AFTERWARDS_US[1])
Suggestions: Afterward
Rule: https://community.languagetool.org/rule/show/AFTERWARDS_US?lang=en-US&subId=1
Category: BRITISH_ENGLISH

Filtered Findings (19)

.github/PULL_REQUEST_TEMPLATE/pre-release-getting-started-script.md|4 col 45| The official name of this software platform is spelled with a capital “H”. (GITHUB[1])
Suggestions: GitHub
URL: https://en.wikipedia.org/wiki/GitHub
Rule: https://community.languagetool.org/rule/show/GITHUB?lang=en-US&subId=1
Category: CASING
.github/PULL_REQUEST_TEMPLATE/pre-release-rust-deps.md|4 col 45| The official name of this software platform is spelled with a capital “H”. (GITHUB[1])
Suggestions: GitHub
URL: https://en.wikipedia.org/wiki/GitHub
Rule: https://community.languagetool.org/rule/show/GITHUB?lang=en-US&subId=1
Category: CASING
.github/pull_request_template.md|16 col 36| This expression is normally spelled as one or with a hyphen. (EN_COMPOUNDS_NON_TRIVIAL)
Suggestions: non-trivial, nontrivial
Rule: https://community.languagetool.org/rule/show/EN_COMPOUNDS_NON_TRIVIAL?lang=en-US
Category: MISC
README.md|66 col 19| It appears that hyphens are missing in the adjective “up-to-date”. (UP_TO_DATE_HYPHEN[2])
Suggestions: up-to-date
URL: https://languagetool.org/insights/post/hyphen/#hyphenated-phrases-with-more-than-one-hyphen
Rule: https://community.languagetool.org/rule/show/UP_TO_DATE_HYPHEN?lang=en-US&subId=2
Category: COMPOUNDING
docs/modules/hive/pages/getting_started/first_steps.adoc|21 col 1| Use “A” instead of ‘An’ if the following word doesn’t start with a vowel sound, e.g. ‘a sentence’, ‘a university’. (EN_A_VS_AN)
Suggestions: A
URL: https://languagetool.org/insights/post/indefinite-articles/
Rule: https://community.languagetool.org/rule/show/EN_A_VS_AN?lang=en-US
Category: MISC
docs/modules/hive/pages/getting_started/first_steps.adoc|78 col 1| In American English, “take a look” is more commonly used. (HAVE_A_LOOK[5])
Suggestions: Take a look
Rule: https://community.languagetool.org/rule/show/HAVE_A_LOOK?lang=en-US&subId=5
Category: BRITISH_ENGLISH
docs/modules/hive/pages/index.adoc|5 col 1| The official name of this software platform is spelled with a capital “H”. (GITHUB[1])
Suggestions: GitHub
URL: https://en.wikipedia.org/wiki/GitHub
Rule: https://community.languagetool.org/rule/show/GITHUB?lang=en-US&subId=1
Category: CASING
docs/modules/hive/pages/index.adoc|11 col 3| The official name of this software platform is spelled with a capital “H”. (GITHUB[1])
Suggestions: GitHub
URL: https://en.wikipedia.org/wiki/GitHub
Rule: https://community.languagetool.org/rule/show/GITHUB?lang=en-US&subId=1
Category: CASING
docs/modules/hive/pages/index.adoc|24 col 1| In American English, ‘afterward’ is the preferred variant. ‘Afterwards’ is more commonly used in British English and other dialects. (AFTERWARDS_US[1])
Suggestions: Afterward
Rule: https://community.languagetool.org/rule/show/AFTERWARDS_US?lang=en-US&subId=1
Category: BRITISH_ENGLISH
docs/modules/hive/pages/index.adoc|25 col 143| In American English, “take a look” is more commonly used. (HAVE_A_LOOK[5])
Suggestions: take a look
Rule: https://community.languagetool.org/rule/show/HAVE_A_LOOK?lang=en-US&subId=5
Category: BRITISH_ENGLISH
docs/modules/hive/pages/index.adoc|80 col 7| The official name of this software platform is spelled with a capital “H”. (GITHUB[1])
Suggestions: GitHub
URL: https://en.wikipedia.org/wiki/GitHub
Rule: https://community.languagetool.org/rule/show/GITHUB?lang=en-US&subId=1
Category: CASING
docs/modules/hive/pages/reference/environment-variables.adoc|27 col 86| Unpaired symbol: ‘"’ seems to be missing (EN_UNPAIRED_QUOTES)
URL: https://languagetool.org/insights/post/punctuation-guide/#what-are-parentheses
Rule: https://community.languagetool.org/rule/show/EN_UNPAIRED_QUOTES?lang=en-US
Category: PUNCTUATION
docs/modules/hive/pages/reference/environment-variables.adoc|56 col 82| Unpaired symbol: ‘"’ seems to be missing (EN_UNPAIRED_QUOTES)
URL: https://languagetool.org/insights/post/punctuation-guide/#what-are-parentheses
Rule: https://community.languagetool.org/rule/show/EN_UNPAIRED_QUOTES?lang=en-US
Category: PUNCTUATION
docs/modules/hive/pages/usage-guide/configuration-environment-overrides.adoc|68 col 1| Consider replacing this phrase with the adverb “similarly” to avoid wordiness. (IN_A_X_MANNER[2])
Suggestions: Similarly
Rule: https://community.languagetool.org/rule/show/IN_A_X_MANNER?lang=en-US&subId=2
Category: REDUNDANCY
docs/modules/hive/pages/usage-guide/database-driver.adoc|13 col 11| If a new sentence starts here, add a space and start with an uppercase letter. (LC_AFTER_PERIOD[1])
Suggestions: Database, database
Rule: https://community.languagetool.org/rule/show/LC_AFTER_PERIOD?lang=en-US&subId=1
Category: CASING
docs/modules/hive/pages/usage-guide/database-driver.adoc|14 col 11| If a new sentence starts here, add a space and start with an uppercase letter. (LC_AFTER_PERIOD[1])
Suggestions: Username, username
Rule: https://community.languagetool.org/rule/show/LC_AFTER_PERIOD?lang=en-US&subId=1
Category: CASING
docs/modules/hive/pages/usage-guide/database-driver.adoc|15 col 11| If a new sentence starts here, add a space and start with an uppercase letter. (LC_AFTER_PERIOD[1])
Suggestions: Password, password
Rule: https://community.languagetool.org/rule/show/LC_AFTER_PERIOD?lang=en-US&subId=1
Category: CASING
docs/modules/hive/pages/usage-guide/security.adoc|45 col 8| Use “a” instead of ‘an’ if the following word doesn’t start with a vowel sound, e.g. ‘a sentence’, ‘a university’. (EN_A_VS_AN)
Suggestions: a
URL: https://languagetool.org/insights/post/indefinite-articles/
Rule: https://community.languagetool.org/rule/show/EN_A_VS_AN?lang=en-US
Category: MISC
tests/README-templating.md|63 col 101| Use a comma before ‘and’ if it connects two independent clauses (unless they are closely connected and short). (COMMA_COMPOUND_SENTENCE[1])
Suggestions: , and
URL: https://languagetool.org/insights/post/types-of-sentences/#compound-sentence
Rule: https://community.languagetool.org/rule/show/COMMA_COMPOUND_SENTENCE?lang=en-US&subId=1
Category: PUNCTUATION

Annotations

Check notice on line 4 in docs/modules/hive/pages/getting_started/first_steps.adoc

See this annotation in the file changed.

@github-actions github-actions / LanguageTool

[LanguageTool] docs/modules/hive/pages/getting_started/first_steps.adoc#L4

In American English, ‘afterward’ is the preferred variant. ‘Afterwards’ is more commonly used in British English and other dialects. (AFTERWARDS_US[1])
Suggestions: `Afterward`
Rule: https://community.languagetool.org/rule/show/AFTERWARDS_US?lang=en-US&subId=1
Category: BRITISH_ENGLISH
Raw output
docs/modules/hive/pages/getting_started/first_steps.adoc:4:181: In American English, ‘afterward’ is the preferred variant. ‘Afterwards’ is more commonly used in British English and other dialects. (AFTERWARDS_US[1])
 Suggestions: `Afterward`
 Rule: https://community.languagetool.org/rule/show/AFTERWARDS_US?lang=en-US&subId=1
 Category: BRITISH_ENGLISH