From adc5ef911fbd3b9a61feb79971f2161c075945fc Mon Sep 17 00:00:00 2001 From: Petros Amoiridis Date: Thu, 30 Mar 2023 14:04:37 +0300 Subject: [PATCH] Remove the Errors section from rust docs The section does not add anything that we don't already know. Co-Authored-By: Antonio Scandurra --- crates/util/src/paths.rs | 6 ------ 1 file changed, 6 deletions(-) diff --git a/crates/util/src/paths.rs b/crates/util/src/paths.rs index b04c12a20499fdbc50f496990de279b6422a3461..3fccb0c896e405ec80303fef1a5027ecc7c3c57f 100644 --- a/crates/util/src/paths.rs +++ b/crates/util/src/paths.rs @@ -54,12 +54,6 @@ pub mod legacy { /// * A `PathBuf` containing the compacted file path. If the input path /// does not have the user's home directory prefix, or if we are not on /// Linux or macOS, the original path is returned unchanged. -/// -/// # Errors -/// -/// This function will not produce any errors, but in case the input path -/// cannot be stripped of the home directory prefix, the original path -/// will be returned unchanged. pub fn compact(path: &Path) -> PathBuf { if cfg!(target_os = "linux") || cfg!(target_os = "macos") { match path.strip_prefix(HOME.as_path()) {