Skip to content

Commit 7d900a6

Browse files
committed
More standard panic heading.
1 parent e29e952 commit 7d900a6

1 file changed

Lines changed: 4 additions & 2 deletions

File tree

gix/src/clone/access.rs

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -49,8 +49,10 @@ impl PrepareFetch {
4949
/// Note that `name` should be a partial name like `main` or `feat/one`, but can be a full ref name.
5050
/// If a branch on the remote matches, it will automatically be retrieved even without a refspec.
5151
///
52-
/// **Warning**: Calling this method with a valid refspec that is not a branch name currently causes
53-
/// subsequent calls to [`PrepareFetch::fetch_only`] or [`PrepareFetch::fetch_then_checkout`] to panic.
52+
/// # Panics
53+
///
54+
/// Calling this method with a valid refspec that is not a branch name, like an object-id as hex-hash,
55+
/// currently causes subsequent calls to [`PrepareFetch::fetch_only`] or [`PrepareFetch::fetch_then_checkout`] to panic.
5456
pub fn with_ref_name<'a, Name, E>(mut self, name: Option<Name>) -> Result<Self, E>
5557
where
5658
Name: TryInto<&'a gix_ref::PartialNameRef, Error = E>,

0 commit comments

Comments
 (0)