update docs (#450)

Byron · Nov 1, 2022 · c788b51 · c788b51
1 parent 443a75a
commit c788b51
Show file tree

Hide file tree

Showing 2 changed files with 8 additions and 4 deletions.
diff --git a/git-repository/src/reference/remote.rs b/git-repository/src/reference/remote.rs
@@ -34,7 +34,7 @@ impl Name<'_> {
 
 /// Remotes
 impl<'repo> Reference<'repo> {
-    /// Find the name of our remote for `direction` as configured in `branch.<name>.remote|pushRemote` respectively.
+    /// Find the unvalidated name of our remote for `direction` as configured in `branch.<name>.remote|pushRemote` respectively.
     /// If `Some(<name>)` it can be used in [`Repository::find_remote(…)`][crate::Repository::find_remote()], or if `None` then
     /// [Repository::remote_default_name()][crate::Repository::remote_default_name()] could be used in its place.
     ///

diff --git a/git-repository/src/repository/config.rs b/git-repository/src/repository/config.rs
@@ -92,10 +92,10 @@ mod branch {
             self.subsection_names_of("branch")
         }
 
-        /// Returns a reference to the remote associated with the given `short_branch_name`,
+        /// Returns the validated reference on the remote associated with the given `short_branch_name`,
         /// always `main` instead of `refs/heads/main`.
         ///
-        /// The remote-ref is the one we track on the remote side for merging and pushing.
+        /// The returned reference is the one we track on the remote side for merging and pushing.
         /// Returns `None` if the remote reference was not found.
         /// May return an error if the reference is invalid.
         pub fn branch_remote_ref(
@@ -111,9 +111,13 @@ mod branch {
                 })
         }
 
-        /// Returns the name of the remote associated with the given `short_branch_name`, typically `main` instead of `refs/heads/main`.
+        /// Returns the unvalidated name of the remote associated with the given `short_branch_name`,
+        /// typically `main` instead of `refs/heads/main`.
         /// In some cases, the returned name will be an URL.
         /// Returns `None` if the remote was not found.
+        ///
+        /// See also [Reference::remote_name()][crate::Reference::remote_name()] for a more typesafe version
+        /// to be used when a `Reference` is available.
         pub fn branch_remote_name(&self, short_branch_name: &str) -> Option<Cow<'_, BStr>> {
             self.config.resolved.string("branch", Some(short_branch_name), "remote")
         }