docs: Resolve CI lints on docs #401
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Code Metrics Report=============================================================================== Language Files Lines Code Comments Blanks =============================================================================== Dockerfile 1 34 25 0 9 Happy 1 442 369 0 73 JSON 9 21 21 0 0 Python 24 864 731 25 108 TOML 15 403 365 1 37 ------------------------------------------------------------------------------- Jupyter Notebooks 1 0 0 0 0 |- Markdown 1 60 30 22 8 |- Python 1 96 87 1 8 (Total) 156 117 23 16 ------------------------------------------------------------------------------- Markdown 16 1057 0 783 274 |- BASH 6 203 190 0 13 |- Python 6 121 110 0 11 |- Rust 3 185 172 9 4 (Total) 1566 472 792 302 ------------------------------------------------------------------------------- Rust 94 29779 27098 437 2244 |- Markdown 48 476 0 463 13 (Total) 30255 27098 900 2257 =============================================================================== Total 162 32600 28609 1246 2745 =============================================================================== |
polarathene
commented
Jun 7, 2024
| @@ -117,7 +117,7 @@ impl Loader for SpeculativeLoader { | |||
| } | |||
| } | |||
|
|
|||
| /// Speculative decoding pipeline: https://arxiv.org/pdf/2211.17192 | |||
| /// Speculative decoding pipeline: <https://arxiv.org/pdf/2211.17192> | |||
There was a problem hiding this comment.
Presumably this will render as a raw URL.
Comment on lines
+92
to
+93
| /// Can be in the formats: `literal:<value>`, `env:<value>`, `path:<value>`, `cache` to use a cached token, or `none` to use no token. | ||
| /// Defaults to `cache`. |
There was a problem hiding this comment.
Switched to backticks instead of double quote wrapping as the CI check considered <value> as HTML tag 🤷♂️
This isn't actually used to generate docs for the crate, only for CLI help. I noticed mistralrs-server is locked down heavily on the docs generated, and assume there is a way to exclude it from showing in the generated docs if there's no intended lib usage via the crate.
This comment was marked as duplicate.
This comment was marked as duplicate.
Sorry, something went wrong.
polarathene
force-pushed
the
chore/ci-housekeeping
branch
from
5c8ee5a
to
94f1f17
Compare
polarathene
commented
Jun 7, 2024
EricLBuehler
approved these changes
Jun 7, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
I'm not familiar with the syntax, I've assumed markdown.
This PR should address the issues the action keeps annotating about unrelated to actual PR changes.