docs: fix memmap2 link and drop unused Streamer import#180
Open
c-tonneslan wants to merge 1 commit into
Open
Conversation
The crate-level docs in lib.rs had two small issues called out in BurntSushi#161 and BurntSushi#152: - The "Example: stream to a file and memory map it" section linked to https://crates.io/memmap2 which is a 404; the canonical URL is https://crates.io/crates/memmap2. - Two of the examples wrote `use fst::{IntoStreamer, Streamer, ...}` but never called any Streamer methods. `into_strs` / `into_str_vec` are inherent on Stream, so the trait import is dead. Dropping it matches the third example which already only imports IntoStreamer. Doctests still pass with the imports trimmed. Closes BurntSushi#161. Closes BurntSushi#152. Signed-off-by: Charlie Tonneslan <cst0520@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
1 participant
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.
Two small crate-level doc cleanups, both called out in #161 and #152:
https://crates.io/memmap2which 404s; canonical URL ishttps://crates.io/crates/memmap2.StreameralongsideIntoStreamerbut never called any of its methods — the rest of the code usesinto_strs/into_str_vecwhich are inherent on the concreteStreamtype. The third example (case-insensitive search) already only importsIntoStreamer, so this just matches that.cargo test --docstill passes:Closes #161. Closes #152.