You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
i.e. has duplicate headers, which causes the linting to fail.
One way to fix this is to set the parameter siblings_only: true as documented here. This is mentioned specifically for the changelog usercase.
Instead, I see e.g. this repository is bypassing the problem by manually adding : <!-- markdownlint-disable MD024 --> in the CHANGELOG.md. The problem I see with this is that BestieTemplate.jl does not generate any changelog file, hence the package author would need to know themselves to add that magic line to the file, which I think is pretty unlikely (I didn't know about it).
Possible solutions:
use the siblings_only: true parameter
generate an empty changelog file with that line (and a title)
The two solutions don't exclude each other, and a question about adding a changelog to the repo could be a nice addition to the template. Nevertheless, I think it would be good to set siblings_only: true anyway. Even outside changelogs, if I want to e.g. document in a tutorial how two types implement the same interface, the following structure doesn't seem bad practice to me
Oh, I like this, I didn't know about sibling_only, let's definitely add it.
On creating a CHANGELOG.md, I agree. I actually have a wishlist for Changelog/version management. I created #55 for start, but I haven't put my whole wishlist anywhere yet
Description
Typically a changelog has a structure like
i.e. has duplicate headers, which causes the linting to fail.
One way to fix this is to set the parameter
siblings_only: true
as documented here. This is mentioned specifically for the changelog usercase.Instead, I see e.g. this repository is bypassing the problem by manually adding :
<!-- markdownlint-disable MD024 -->
in theCHANGELOG.md
. The problem I see with this is that BestieTemplate.jl does not generate any changelog file, hence the package author would need to know themselves to add that magic line to the file, which I think is pretty unlikely (I didn't know about it).Possible solutions:
siblings_only: true
parameterThe two solutions don't exclude each other, and a question about adding a changelog to the repo could be a nice addition to the template. Nevertheless, I think it would be good to set
siblings_only: true
anyway. Even outside changelogs, if I want to e.g. document in a tutorial how two types implement the same interface, the following structure doesn't seem bad practice to mePackage Version
0.13.0
Julia Version
0.11
Reproduction steps
have the following markdown file
and run
pre-commit run -a
Relevant log output
No response
Operating System
No response
The text was updated successfully, but these errors were encountered: