Skip to content

Commit

Permalink
Add additional documentation on runtime directory
Browse files Browse the repository at this point in the history
  • Loading branch information
soc committed Sep 15, 2021
1 parent 8f14dfc commit 0c63034
Showing 1 changed file with 3 additions and 0 deletions.
3 changes: 3 additions & 0 deletions src/lib.rs
Original file line number Diff line number Diff line change
Expand Up @@ -148,6 +148,9 @@ pub fn preference_dir() -> Option<PathBuf> {
}
/// Returns the path to the user's runtime directory.
///
/// The runtime directory contains transient, non-essential data (like sockets or named pipes) that
/// is expected to be cleared when the user's session ends.
///
/// The returned value depends on the operating system and is either a `Some`, containing a value from the following table, or a `None`.
///
/// |Platform | Value | Example |
Expand Down

0 comments on commit 0c63034

Please sign in to comment.