Add comment on when to use new methods

Author: cruessler

gix/src/lib.rs

@@ -223,6 +223,8 @@ pub fn discover(directory: impl AsRef<std::path::Path>) -> Result<Repository, di
 }
 
 /// See [`ThreadSafeRepository::discover_with_environment_overrides()`], but returns a [`Repository`] instead.
+///
+/// Use this method if you want a [`Repository`], but don't require it to be `Sync`.
 #[allow(clippy::result_large_err)]
 pub fn discover_with_environment_overrides(
     directory: impl AsRef<std::path::Path>,
@@ -231,6 +233,8 @@ pub fn discover_with_environment_overrides(
 }
 
 /// See [`ThreadSafeRepository::open_with_environment_overrides()`], but returns a [`Repository`] instead.
+///
+/// Use this method if you want a [`Repository`], but don't require it to be `Sync`.
 #[allow(clippy::result_large_err)]
 pub fn open_with_environment_overrides(directory: impl Into<std::path::PathBuf>) -> Result<Repository, open::Error> {
     ThreadSafeRepository::open_with_environment_overrides(directory, Default::default()).map(Into::into)