UKGovernmentBEIS / inspect_ai

Inspect: A framework for large language model evaluations
https://UKGovernmentBEIS.github.io/inspect_ai/
MIT License
385 stars 41 forks source link

Fix Markdown warnings #62

Closed bact closed 4 days ago

bact commented 6 days ago

Fix warnings from markdownlint

Ref: https://github.com/DavidAnson/markdownlint/blob/v0.34.0/doc/Rules.md

This PR contains:

What is the current behavior? (You can also link to an open issue here)

No change in behavior

What is the new behavior?

No change in behavior

Does this PR introduce a breaking change? (What changes might users need to make in their application due to this PR?)

No

Other information:

jjallaire commented 4 days ago

Thanks for this! Our markdown is sometimes hand-edited but sometimes authored with the Quarto visual markdown editor (https://quarto.org/docs/visual-editor/vscode/). This in turn uses Pandoc to write markdown, and we will just get whatever it's default behavior is (i.e. we can't actually customise it). So running a non-Pandoc based linter will probably always end up yielding errors of this kind.

So net, net I don't think we should try to fix these (btw in some cases we don't specify a language for fenced code blocks so that there is no shaded background (that is the Quarto default behavior).

bact commented 4 days ago

Thank you for the clarification!