Remove the Errors section from rust docs

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

Co-Authored-By: Antonio Scandurra <me@as-cii.com>
This commit is contained in:
Petros Amoiridis 2023-03-30 14:04:37 +03:00
parent 18c6c7ebb7
commit adc5ef911f
No known key found for this signature in database

View File

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