dimforge / dimforge/nalgebra

The `[dependencies]` sample in the top level should be marked as toml

Open
#538 0 comments 0 reactions 0 assignees View on GitHub
Dominant language
Rust
Stars
4.8k
Forks
565
PR merge metrics
No merged PRs in 30d

Description

So someone clearly didn't want the `[dependencies]` example entry to be a rustdoc test, which is correct and all, but instead of marking the block as `ignore` (which makes the rustdoc highlight it with a spooky warning) you should mark it as being `toml`, which which prevent rustdoc from trying to look inside the block and marking it as spooky untested code.

So, just replace

\`\`\`.ignore
[dependencies]
nalgebra = "0.17"
\`\`\`

With

\`\`\`toml
[dependencies]
nalgebra = "0.17"
\`\`\`

Contributor guide

No contributing guide indexed for this repository

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.