Skip to content

docs improvements

docs improvements #427

GitHub Actions / LanguageTool completed Aug 24, 2023 in 1s

reviewdog [LanguageTool] report

reported by reviewdog 🐶

Findings (4)

docs/modules/opa/pages/usage-guide/resources.adoc|7 col 3| Insert a space between the numerical value and the unit symbol. (UNIT_SPACE[1])
Suggestions: 600 m
Rule: https://community.languagetool.org/rule/show/UNIT_SPACE?lang=en-US&subId=1
Category: PUNCTUATION
docs/modules/opa/pages/usage-guide/resources.adoc|8 col 3| Insert a space between the numerical value and the unit symbol. (UNIT_SPACE[1])
Suggestions: 1200 m
Rule: https://community.languagetool.org/rule/show/UNIT_SPACE?lang=en-US&subId=1
Category: PUNCTUATION
docs/modules/opa/pages/usage-guide/resources.adoc|23 col 17| Insert a space between the numerical value and the unit symbol. (UNIT_SPACE[1])
Suggestions: 250 m
Rule: https://community.languagetool.org/rule/show/UNIT_SPACE?lang=en-US&subId=1
Category: PUNCTUATION
docs/modules/opa/pages/usage-guide/resources.adoc|24 col 17| Insert a space between the numerical value and the unit symbol. (UNIT_SPACE[1])
Suggestions: 500 m
Rule: https://community.languagetool.org/rule/show/UNIT_SPACE?lang=en-US&subId=1
Category: PUNCTUATION

Filtered Findings (8)

.github/pull_request_template.md|16 col 36| This expression is normally spelled as one or with a hyphen. (EN_COMPOUNDS)
Suggestions: non-trivial, nontrivial
URL: https://languagetool.org/insights/post/hyphen/
Rule: https://community.languagetool.org/rule/show/EN_COMPOUNDS?lang=en-US
Category: MISC
CHANGELOG.md|127 col 17| This expression is normally spelled as one or with a hyphen. (EN_COMPOUNDS)
Suggestions: side-car, sidecar
URL: https://languagetool.org/insights/post/hyphen/
Rule: https://community.languagetool.org/rule/show/EN_COMPOUNDS?lang=en-US
Category: MISC
README.md|61 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/opa/pages/getting_started/index.adoc|17 col 2| Insert a space between the numerical value and the unit symbol. (UNIT_SPACE[1])
Suggestions: 256 MB
Rule: https://community.languagetool.org/rule/show/UNIT_SPACE?lang=en-US&subId=1
Category: PUNCTUATION
docs/modules/opa/pages/implementation-notes.adoc|11 col 27| 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/opa/pages/implementation-notes.adoc|21 col 52| Insert a space between the numerical value and the unit symbol. (UNIT_SPACE[1])
Suggestions: 1 MB
Rule: https://community.languagetool.org/rule/show/UNIT_SPACE?lang=en-US&subId=1
Category: PUNCTUATION
docs/modules/opa/pages/index.adoc|26 col 1| A comma may be missing after the conjunctive/linking adverb ‘Currently’. (SENT_START_CONJUNCTIVE_LINKING_ADVERB_COMMA[1])
Suggestions: Currently,
URL: https://languagetool.org/insights/post/linking-words/
Rule: https://community.languagetool.org/rule/show/SENT_START_CONJUNCTIVE_LINKING_ADVERB_COMMA?lang=en-US&subId=1
Category: PUNCTUATION
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/grammar-what-are-compound-sentences/
Rule: https://community.languagetool.org/rule/show/COMMA_COMPOUND_SENTENCE?lang=en-US&subId=1
Category: PUNCTUATION

Annotations

Check notice on line 7 in docs/modules/opa/pages/usage-guide/resources.adoc

See this annotation in the file changed.

@github-actions github-actions / LanguageTool

[LanguageTool] docs/modules/opa/pages/usage-guide/resources.adoc#L7

Insert a space between the numerical value and the unit symbol. (UNIT_SPACE[1])
Suggestions: `600 m`
Rule: https://community.languagetool.org/rule/show/UNIT_SPACE?lang=en-US&subId=1
Category: PUNCTUATION
Raw output
docs/modules/opa/pages/usage-guide/resources.adoc:7:3: Insert a space between the numerical value and the unit symbol. (UNIT_SPACE[1])
 Suggestions: `600 m`
 Rule: https://community.languagetool.org/rule/show/UNIT_SPACE?lang=en-US&subId=1
 Category: PUNCTUATION

Check notice on line 8 in docs/modules/opa/pages/usage-guide/resources.adoc

See this annotation in the file changed.

@github-actions github-actions / LanguageTool

[LanguageTool] docs/modules/opa/pages/usage-guide/resources.adoc#L8

Insert a space between the numerical value and the unit symbol. (UNIT_SPACE[1])
Suggestions: `1200 m`
Rule: https://community.languagetool.org/rule/show/UNIT_SPACE?lang=en-US&subId=1
Category: PUNCTUATION
Raw output
docs/modules/opa/pages/usage-guide/resources.adoc:8:3: Insert a space between the numerical value and the unit symbol. (UNIT_SPACE[1])
 Suggestions: `1200 m`
 Rule: https://community.languagetool.org/rule/show/UNIT_SPACE?lang=en-US&subId=1
 Category: PUNCTUATION

Check notice on line 23 in docs/modules/opa/pages/usage-guide/resources.adoc

See this annotation in the file changed.

@github-actions github-actions / LanguageTool

[LanguageTool] docs/modules/opa/pages/usage-guide/resources.adoc#L23

Insert a space between the numerical value and the unit symbol. (UNIT_SPACE[1])
Suggestions: `250 m`
Rule: https://community.languagetool.org/rule/show/UNIT_SPACE?lang=en-US&subId=1
Category: PUNCTUATION
Raw output
docs/modules/opa/pages/usage-guide/resources.adoc:23:17: Insert a space between the numerical value and the unit symbol. (UNIT_SPACE[1])
 Suggestions: `250 m`
 Rule: https://community.languagetool.org/rule/show/UNIT_SPACE?lang=en-US&subId=1
 Category: PUNCTUATION

Check notice on line 24 in docs/modules/opa/pages/usage-guide/resources.adoc

See this annotation in the file changed.

@github-actions github-actions / LanguageTool

[LanguageTool] docs/modules/opa/pages/usage-guide/resources.adoc#L24

Insert a space between the numerical value and the unit symbol. (UNIT_SPACE[1])
Suggestions: `500 m`
Rule: https://community.languagetool.org/rule/show/UNIT_SPACE?lang=en-US&subId=1
Category: PUNCTUATION
Raw output
docs/modules/opa/pages/usage-guide/resources.adoc:24:17: Insert a space between the numerical value and the unit symbol. (UNIT_SPACE[1])
 Suggestions: `500 m`
 Rule: https://community.languagetool.org/rule/show/UNIT_SPACE?lang=en-US&subId=1
 Category: PUNCTUATION