Remove the Errors section from rust docs

Petros Amoiridis and Antonio Scandurra created 2 years ago

The section does not add anything that we don't already know.

Co-Authored-By: Antonio Scandurra <[e-mail]>

Change summary

crates/util/src/paths.rs | 6 ------
1 file changed, 6 deletions(-)

Detailed changes

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()) {