WIP: activate MD061 and MD044 - CMEM-8136 - #258
Open
annamakor wants to merge 2 commits into
Open
Conversation
Test Results 1 files 32 suites 0s ⏱️ For more details on these failures, see this check. Results for commit 7982353. ♻️ This comment has been updated with latest results. |
Resolve all MD061 (forbidden terms) and MD044 (proper name casing) findings in files that are not machine-generated: expand contractions, drop politeness fillers, correct GitHub/GitLab/JavaScript/TypeScript/eccenca/Corporate Memory. Two config decisions in .rumdl.toml: - Drop "cannot" from [MD061].terms. It is not a contraction but the standard spelling, and it is what "can't" has to be corrected to. Keeping it would have forced 40 correct sentences into the awkward "can not". - List technical identifiers at the top of [MD044].names, before the brand names they contain. MD044 resolves overlaps by the longer match, so this stops rumdl --fix from destroying Material icon shortcodes (icon: material/github, :simple-gitlab:), the gitlab.eccenca.com hostname and LOGGING_LEVEL_COM_ECCENCA_* environment variables. Add tests/test_rumdl_md044_allowlist.py to pin the allowlist down: the protected identifiers must survive rumdl --fix, and the rule must keep reporting the same names in running text. Files carrying a "generated - do not change manually" marker are left untouched; the 42 findings remaining there need fixes in their generators. Note that the graph-insights files declared generated in _README.md carry no inline marker of their own. Also correct proper names inside link text, which MD044 does not inspect.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
No description provided.