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".
--- a/rust/hg-core/src/revlog/changelog.rs Tue Mar 21 20:47:30 2023 -0400
+++ b/rust/hg-core/src/revlog/changelog.rs Wed Mar 29 20:24:58 2023 +0200
@@ -9,7 +9,7 @@
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 @@
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 @@
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 @@
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,