changeset 50450:e2c8b30ab4e7

rustdoc: wording for checkexec Notably separating the summary line for correct display at module level.
author Georges Racinet <georges.racinet@octobus.net>
date Mon, 03 Apr 2023 15:58:36 +0200
parents 331a3cbe1c9e
children d27b6fc7c1bf
files rust/hg-core/src/checkexec.rs
diffstat 1 files changed, 4 insertions(+), 2 deletions(-) [+]
line wrap: on
line diff
--- a/rust/hg-core/src/checkexec.rs	Mon Apr 03 15:32:39 2023 +0200
+++ b/rust/hg-core/src/checkexec.rs	Mon Apr 03 15:58:36 2023 +0200
@@ -112,8 +112,10 @@
     Ok(false)
 }
 
-/// This function is a rust rewrite of `checkexec` function from `posix.py`
-/// Returns true if the filesystem supports execute permissions.
+/// This function is a Rust rewrite of the `checkexec` function from
+/// `posix.py`.
+///
+/// Returns `true` if the filesystem supports execute permissions.
 pub fn check_exec(path: impl AsRef<Path>) -> bool {
     check_exec_impl(path).unwrap_or(false)
 }