Fixing Docs.rs #905
Merged
Fixing Docs.rs #905
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
At the moment docs.rs fails to compile due to not being able to link to Cuda or other backend specific configurations, which it seemingly has to do to compile the docs of those crates. I have now removed the backends from being part of the included features to be displayed on docs.rs, so that only the crates that pertains to the upper-level api remains. As it was me who added the all-features flag in the first place, I must apologize for any inconvenience caused! The resulting docs.rs output can be seen by running: cargo doc -F dataset -F default -F std -F train -F train-tui -F train-metrics -F dataset-sqlite --open
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #905 +/- ##
=======================================
Coverage 86.33% 86.33%
=======================================
Files 469 469
Lines 44030 44030
=======================================
Hits 38014 38014
Misses 6016 6016 ☔ View full report in Codecov by Sentry. |
|
@ArvidHammarlund No worries, it's hard to actually test the flags without actually pushing on docs.rs. Thanks for fixing it :) |
nathanielsimard
approved these changes
Oct 26, 2023
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.
At the moment docs.rs fails to compile due to
not being able to link to Cuda or other backend
specific configurations, which it seemingly has
to do to compile the docs of those crates.
I have now removed the backends from being part
of the included features to be displayed on
docs.rs, so that only the crates that pertains
to the upper-level api remains.
As it was me who added the all-features flag in
the first place, I must apologize for any
inconvenience caused!
The resulting docs.rs output can be seen by running: cargo doc -F dataset -F default -F std -F train -F train-tui -F train-metrics -F dataset-sqlite --open