docs(nalgebra-sparse): clarify required features for front-page example - #1606
Open
wilmerdooley wants to merge 1 commit into
Open
docs(nalgebra-sparse): clarify required features for front-page example#1606wilmerdooley wants to merge 1 commit into
wilmerdooley wants to merge 1 commit into
Conversation
Signed-off-by: wilmerdooley <wilmerdooley1@gmail.com>
This file contains hidden or 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
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.
The front-page example in
nalgebra-sparseusesmatrixcompareto assert that the sparse and dense matrices agree, but the surrounding documentation did not mention thecomparefeature onnalgebraandnalgebra-sparsethat this example needs. Without those features, new users copy-pasting the example will hit unresolved imports, which has been a source of confusion.This change adds a short note and a
Cargo.tomlsnippet above the example innalgebra-sparse/src/lib.rsso readers can see exactly which dependencies and features to enable.Resolves #1214
Changes
nalgebra-sparse/src/lib.rsexplaining that thecomparefeature is required on bothnalgebra-sparseandnalgebra.Cargo.tomlsnippet showing the required dependencies and feature flags for the example to compile.