# HG changeset patch
# User Georges Racinet <georges.racinet@octobus.net>
# Date 2023-03-29 18:24:58
# Node ID b47a9316050aa583a006cef9d60195e2ed6c41a1
# Parent  82e5a9b1ef1ea7f8b2bc351df75fa3a67f5cf9a4

rust-changelog: made doc-comments more consistent

The most important is the one about `data_for_rev`, that looked like
a copy-paste leftover (got me confused first time I read this code, before
I actually learned there were both `Entry` and RevisionData`.

In the comment for the `struct`, "changelog" was probably more about
the format in general (as documented elsewhere) than as an identifier.

Some of the "Return something" had "of", half had "for".

diff --git a/rust/hg-core/src/revlog/changelog.rs b/rust/hg-core/src/revlog/changelog.rs
--- a/rust/hg-core/src/revlog/changelog.rs
+++ b/rust/hg-core/src/revlog/changelog.rs
@@ -9,7 +9,7 @@ use std::ascii::escape_default;
 use std::borrow::Cow;
 use std::fmt::{Debug, Formatter};
 
-/// A specialized `Revlog` to work with `changelog` data format.
+/// A specialized `Revlog` to work with changelog data format.
 pub struct Changelog {
     /// The generic `revlog` format.
     pub(crate) revlog: Revlog,
@@ -23,7 +23,7 @@ impl Changelog {
         Ok(Self { revlog })
     }
 
-    /// Return the `ChangelogEntry` for the given node ID.
+    /// Return the `ChangelogRevisionData` for the given node ID.
     pub fn data_for_node(
         &self,
         node: NodePrefix,
@@ -32,7 +32,7 @@ impl Changelog {
         self.data_for_rev(rev)
     }
 
-    /// Return the `RevlogEntry` of the given revision number.
+    /// Return the `RevlogEntry` for the given revision number.
     pub fn entry_for_rev(
         &self,
         rev: Revision,
@@ -40,7 +40,7 @@ impl Changelog {
         self.revlog.get_entry(rev)
     }
 
-    /// Return the `ChangelogEntry` of the given revision number.
+    /// Return the [`ChangelogRevisionData`] for the given revision number.
     pub fn data_for_rev(
         &self,
         rev: Revision,