-
Notifications
You must be signed in to change notification settings - Fork 7
Description
Overview
Currently the syntax requires the targeting expression to be on the same line as the file path, i.e., [Title](Path) targeting_expr
. However, the file paths can be long. If the max line length is enforced with a linter and the [Title](Path)
part exceeds the limit, the linter will report a violation because the targeting_expr is separated with a space and is located beyond the limit (linters usually allow paths to be arbitrary long, but do not permit other words after them).
Also, allowing targeting expr on the next line might improve readability without "soft" line wraps.
<!--codeinclude-->
[Title](long/long/Path)
targeting_expr1
[Title2](long/long/Path)
targeting_expr2
<!--/codeinclude-->
Workaround
For linters: suppress the check for each codeinclude fragment <!-- markdownlint-disable line-length -->
followed by <!-- markdownlint-enable line-length -->
. One won't have to write that each time, just add an editor macro (e.g. Live Template in Intellij), but the reviewers will have to read that anyway.