bids-standard / bids-specification

Brain Imaging Data Structure (BIDS) Specification
https://bids-specification.readthedocs.io/
Creative Commons Attribution 4.0 International
265 stars 154 forks source link

FIX: Markdown linter throws false positives if definitions are only used inside admonition blocks #1760

Closed oesteban closed 3 months ago

oesteban commented 3 months ago

What we see in the context of #1750 seems to respond to remarkjs/remark-lint#307.

This bugfix adds the dependency (as suggested in the issue) and adds one canary to ensure it is working.

cc/ @Remi-Gau

oesteban commented 3 months ago

Converting to draft because this doesn't seem to work. And it seems the common-principles.md file is not linted?

codecov[bot] commented 3 months ago

Codecov Report

All modified and coverable lines are covered by tests :white_check_mark:

Project coverage is 87.93%. Comparing base (dbcb237) to head (1bc2fc4).

Additional details and impacted files ```diff @@ Coverage Diff @@ ## master #1760 +/- ## ======================================= Coverage 87.93% 87.93% ======================================= Files 16 16 Lines 1351 1351 ======================================= Hits 1188 1188 Misses 163 163 ```

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.

Remi-Gau commented 3 months ago

not sure if it helps but I had to tweak some remark linting rules when I introduced admonitions: https://github.com/bids-standard/bids-specification/blob/dbcb237d14970bc75c4837a4c1b317aa5a267cc8/.remarkrc#L13

oesteban commented 3 months ago

not sure if it helps but I had to tweak some remark linting rules when I introduced admonitions:

https://github.com/bids-standard/bids-specification/blob/dbcb237d14970bc75c4837a4c1b317aa5a267cc8/.remarkrc#L13

Thanks for the suggestion. A naive addition of the plugin did not work (https://github.com/bids-standard/bids-specification/pull/1750/commits/cd9c926e6c52bd96c758e739d1044ee5912d966f)

oesteban commented 3 months ago

Defining the links inside the admonition at hand does the trick. Closing as not needed.