aboutsummaryrefslogtreecommitdiff
path: root/mingling/src/res/dirs/current_dir.rs
diff options
context:
space:
mode:
Diffstat (limited to 'mingling/src/res/dirs/current_dir.rs')
-rw-r--r--mingling/src/res/dirs/current_dir.rs9
1 files changed, 6 insertions, 3 deletions
diff --git a/mingling/src/res/dirs/current_dir.rs b/mingling/src/res/dirs/current_dir.rs
index 54d2b05..2dd6633 100644
--- a/mingling/src/res/dirs/current_dir.rs
+++ b/mingling/src/res/dirs/current_dir.rs
@@ -23,9 +23,12 @@ pub struct ResCurrentDir {
impl ResCurrentDir {
/// Creates a new `ResCurrentDir` by querying the OS for the current working directory.
///
- /// Returns `Err` if the current directory cannot be determined (e.g., the directory has been
- /// deleted or permissions are insufficient). Unlike the `Default` implementation, this
- /// method does not panic on failure.
+ /// # Errors
+ ///
+ /// Returns an `Err` if the current directory cannot be determined (e.g., the directory has
+ /// been deleted or permissions are insufficient).
+ ///
+ /// Unlike the `Default` implementation, this method does not panic on failure.
pub fn new() -> Result<Self, std::io::Error> {
Ok(Self {
cwd: current_dir()?,