Skip to content

Commit

Permalink
doc: Link to examples of how to update the sparse index
Browse files Browse the repository at this point in the history
  • Loading branch information
nicholasbishop authored and Byron committed Nov 11, 2023
1 parent 239b009 commit 39d9fb6
Showing 1 changed file with 5 additions and 0 deletions.
5 changes: 5 additions & 0 deletions src/lib.rs
Original file line number Diff line number Diff line change
Expand Up @@ -152,6 +152,11 @@ pub use error::Error;
/// Wrapper around managing a sparse HTTP index, re-using Cargo's local disk caches.
///
/// Currently it only uses local Cargo cache, and does not access the network in any way.
/// For examples of how to update the local cache,
/// see [`examples/sparse_http_reqwest.rs`][reqwest] and [`examples/sparse_http_ureq.rs`][ureq].
///
/// [reqwest]: https://github.com/frewsxcv/rust-crates-index/blob/HEAD/examples/sparse_http_reqwest.rs
/// [ureq]: https://github.com/frewsxcv/rust-crates-index/blob/HEAD/examples/sparse_http_ureq.rs
pub struct SparseIndex {
path: PathBuf,
url: String,
Expand Down

0 comments on commit 39d9fb6

Please sign in to comment.