make link checker less strict + fix docs#1008
Conversation
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #1008 +/- ##
=======================================
Coverage 84.26% 84.26%
=======================================
Files 52 52
Lines 5974 5974
Branches 5974 5974
=======================================
Hits 5034 5034
Misses 695 695
Partials 245 245 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
Aurashk
changed the title
src/graph/investment.rs
Outdated
| } | ||
|
|
||
| // Enforce transitivity to avoid 3-cycles: x[i][j] + x[j][k] + x[k][i] ≤ 2. | ||
| // Enforce transitivity to avoid 3-cycles: `x[i][j]` + x[j][k] + x[k][i] ≤ 2. |
There was a problem hiding this comment.
Why do we need the first one to be in backticks and not the other ones?
There was a problem hiding this comment.
I was overly liberal with the backticks actually, you only need them in the triple slash docs. I think they are fine in the double slash comments
| [book] | ||
| authors = ["Alex Dewar"] | ||
| language = "en" | ||
| multilingual = false |
There was a problem hiding this comment.
Do we know what this was for and why it's no longer supported?
There was a problem hiding this comment.
I've had a look at the mdbook docs but can't find a trace of it https://rust-lang.github.io/mdBook/format/configuration/general.html
There was a problem hiding this comment.
feels like it's not really designed for multilingual support since you are meant to specify a main language by doing language = "en" so don't really understand
There was a problem hiding this comment.
Strange. Oh well, maybe @alexdewar can answer this when he's back since he set this up in the first place
There was a problem hiding this comment.
https://github.com/rust-lang/mdBook/blob/master/CHANGELOG.md#05-migration-guide Looks like it was dropped with v0.5 which was released a couple of days ago, although apparently it was never used in the first place
| uses: lycheeverse/lychee-action@v2 | ||
| with: | ||
| args: "--verbose --no-progress --exclude-path ^target './**/*.md' './**/*.html'" | ||
| args: "--verbose --no-progress --accept 200,203,503 --exclude-path ^target './**/*.md' './**/*.html'" |
There was a problem hiding this comment.
What do these codes mean?
There was a problem hiding this comment.
200: Everything is ok and normal lychee only accepts this one by default
503 Service Unavailable: The server is temporarily overloaded, under maintenance, or otherwise unable to handle the request. The Zenodo link in an md file was returning this and being slow, which was causing a CI failure, but I think should be a pass since it's generally only temporary
203 Non-Authoritative Information: The request succeeded, but the response came from a cache or proxy rather than the origin server. Some CDNs or caching layers return this instead of 200.
src/graph/investment.rs
Outdated
| } | ||
|
|
||
| // Enforce antisymmetry: for each pair (i, j), exactly one of x[i][j] and x[j][i] is 1. | ||
| // Enforce antisymmetry: for each pair (i, j), exactly one of x[i][j] and `x[j][i]`` is 1. |
There was a problem hiding this comment.
| // Enforce antisymmetry: for each pair (i, j), exactly one of x[i][j] and `x[j][i]`` is 1. | |
| // Enforce antisymmetry: for each pair (i, j), exactly one of x[i][j] and `x[j][i]` is 1. |
2 participants
Description
removes an unrecognised parameter from book.toml so the CI will stop failing.
Also change lychee so it accepts 503 and 203 status codes, currently zenodo is slow for some reason but the link does work
Type of change
Key checklist
$ cargo test$ cargo docFurther checks