Wording check is not clear

What is the purpose of the following line:

https://gitlab.hrz.tu-chemnitz.de/zih/hpcsupport/hpc-compendium/-/blob/preview/doc.zih.tu-dresden.de/util/grep-forbidden-words.sh#L23

Where is this check mentioned in the content rules (https://gitlab.hrz.tu-chemnitz.de/zih/hpcsupport/hpc-compendium/-/blob/preview/doc.zih.tu-dresden.de/docs/contrib/content_rules.md#spelling-and-technical-wording)?

added CI/CD Pipeline label

assigned to @s2817051--tu-dresden.de

This rule is for checking whether there is a space at the end of a line. Spaces at the end of a line is unnecessary and should generally be avoided.

closed

reopened

The output of the check script is not clear. Please add more information.

Please describe your expectations.

Trailing spaces are checked with markdownlint setting https://github.com/DavidAnson/markdownlint/blob/main/doc/Rules.md#md009---trailing-spaces which we also have enabled. Moreover it already provides information and can be autofixed.

Therefore the check above can be removed.

Moreover for me it was not clear at all what [[:space:]]$ stays for and why the check has triggered.

Previously, I found some files with trailing spaces on lines. Therefore, I added that rule.

In contrast to the rule in the linter, the above check will find additionally trailing spaces only inside code blocks, which are explicitly excluded in the linter ruleset:

Note: Trailing space is allowed in indented and fenced code blocks because some languages require it.

Therefore, I suggest to remove the pattern [[:space:]]$ from the script as it duplicates the rule in markdownlinter.

mentioned in commit 7f25abc1

Please check whether the updated script on https://gitlab.hrz.tu-chemnitz.de/zih/hpcsupport/hpc-compendium/-/tree/205-there-is-no-test-suite-for-grep-forbidden-words-sh helps. Feel free to also review !383 (merged).

The added information is very helpful! Thanks.

closed with commit 7f25abc1

mentioned in commit dce582ff

closed with merge request !383 (merged)