rustdoc: fixed warnings about links
authorGeorges Racinet <georges.racinet@octobus.net>
Mon, 03 Apr 2023 15:32:39 +0200
changeset 50415 331a3cbe1c9e
parent 50414 071a6c1d291e
child 50416 e2c8b30ab4e7
rustdoc: fixed warnings about links This is the minimal fix making those that actually were supposed to be links to work (including in private items).
rust/hg-core/src/checkexec.rs
rust/hg-core/src/revlog/nodemap.rs
rust/hg-core/src/utils.rs
rust/hg-core/src/utils/hg_path.rs
--- a/rust/hg-core/src/checkexec.rs	Thu Mar 30 12:21:38 2023 +0200
+++ b/rust/hg-core/src/checkexec.rs	Mon Apr 03 15:32:39 2023 +0200
@@ -112,7 +112,7 @@
     Ok(false)
 }
 
-/// This function is a rust rewrite of [checkexec] function from [posix.py]
+/// This function is a rust rewrite of `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)
--- a/rust/hg-core/src/revlog/nodemap.rs	Thu Mar 30 12:21:38 2023 +0200
+++ b/rust/hg-core/src/revlog/nodemap.rs	Mon Apr 03 15:32:39 2023 +0200
@@ -69,8 +69,8 @@
     ///
     /// If no Revision matches the given prefix, `Ok(None)` is returned.
     ///
-    /// If several Revisions match the given prefix, a [`MultipleResults`]
-    /// error is returned.
+    /// If several Revisions match the given prefix, a
+    /// [MultipleResults](NodeMapError)  error is returned.
     fn find_bin(
         &self,
         idx: &impl RevlogIndex,
@@ -86,8 +86,8 @@
     ///
     /// Returns `None` if no `Revision` could be found for the prefix.
     ///
-    /// If several Revisions match the given prefix, a [`MultipleResults`]
-    /// error is returned.
+    /// If several Revisions match the given prefix, a
+    /// [MultipleResults](NodeMapError)  error is returned.
     fn unique_prefix_len_bin(
         &self,
         idx: &impl RevlogIndex,
@@ -113,7 +113,7 @@
     ) -> Result<(), NodeMapError>;
 }
 
-/// Low level NodeTree [`Blocks`] elements
+/// Low level NodeTree [`Block`] elements
 ///
 /// These are exactly as for instance on persistent storage.
 type RawElement = unaligned::I32Be;
--- a/rust/hg-core/src/utils.rs	Thu Mar 30 12:21:38 2023 +0200
+++ b/rust/hg-core/src/utils.rs	Mon Apr 03 15:32:39 2023 +0200
@@ -301,7 +301,7 @@
 /// calling `merge(key, left_value, right_value)` to resolve keys that exist in
 /// both.
 ///
-/// CC https://github.com/bodil/im-rs/issues/166
+/// CC <https://github.com/bodil/im-rs/issues/166>
 pub(crate) fn ordmap_union_with_merge<K, V>(
     left: OrdMap<K, V>,
     right: OrdMap<K, V>,
--- a/rust/hg-core/src/utils/hg_path.rs	Thu Mar 30 12:21:38 2023 +0200
+++ b/rust/hg-core/src/utils/hg_path.rs	Mon Apr 03 15:32:39 2023 +0200
@@ -479,7 +479,7 @@
     }
 }
 
-/// TODO: Once https://www.mercurial-scm.org/wiki/WindowsUTF8Plan is
+/// TODO: Once <https://www.mercurial-scm.org/wiki/WindowsUTF8Plan> is
 /// implemented, these conversion utils will have to work differently depending
 /// on the repository encoding: either `UTF-8` or `MBCS`.