Skip to content

Commit 9a67562

Browse files
committed
Repository: Add doc comment for relative_index_file()
1 parent b388d46 commit 9a67562

File tree

1 file changed

+4
-0
lines changed

1 file changed

+4
-0
lines changed

src/git.rs

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -192,6 +192,10 @@ impl Repository {
192192
.join(Self::relative_index_file(name))
193193
}
194194

195+
/// Returns the relative path to the crate index file that corresponds to
196+
/// the given crate name.
197+
///
198+
/// see <https://doc.rust-lang.org/cargo/reference/registries.html#index-format>
195199
pub fn relative_index_file(name: &str) -> PathBuf {
196200
let name = name.to_lowercase();
197201
match name.len() {

0 commit comments

Comments
 (0)