Allow clippy::doc_markdown
in code-validation
and fix lint-tools
job
#1403
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.
Allow
clippy::doc_markdown
incode-validation
Fixes #1399!
This change disables the
clippy::doc_markdown
lint for ourcode-validation
tool. This lint requires code-like text to be surrounded by backticks. The problem with it is that it thinks Tera templates{{ ... }}
and front-matter are code-like, and wants backticks around them. Doing so would break the website, though.While it is nice to catch missing backticks, it's not
code-validation
's first responsibility. It's first responsibility is to test all of our code blocks to ensure they are valid.One final note: I originally tried using the
[lint]
table inCargo.toml
to disable this lint, butworkspace = true
is incompatible with this: I would have had to duplicate all of[workspace.lints]
. Instead, I opted to just use a crate attribute.Fix
lint-tools
jobThere were several structs and fields that were never used, so I deleted them. Furthermore,
IssueError
was raising a warning because the fields of its variants were never read. I fixed this by implementingstd::error::Error
for it, which exposes thesource
error when the question mark?
operator is used.thiserror
was already in our dependency tree, so it should not hurt compile times too much.