model: fix stale and unclosed-tag rustdoc in comment and review
commit
6e4c4b2model: fix stale and unclosed-tag rustdoc in comment and review
Drops a false claim in thread_of’s doc that comments read through a legacy fallback (removed in the clean break), and backticks the porcelain grammar and ref-path examples so rustdoc stops parsing the angle-bracket grammar as HTML tags.
model: drop the stale legacy-fallback claim from thread_of’s doc model: backtick angle-bracket grammar in comment and review --help text Assisted-by: Claude:claude-fable-5
Reviews
No reviews of this commit yet — record a verdict below.
Start a review
crates/forge/ents-forge/src/comment/cli.rs
@@ -20,11 +20,11 @@
///
/// With --porcelain, emits a stable machine-readable form:
/// blank-line-separated records, each starting with the line
- /// "<id> <state> <projection> <location>" — projection is current,
+ /// `<id> <state> <projection> <location>` — projection is current,
/// relocated, outdated, or deleted ("-" for a comment with no
- /// anchor); location is "path:start-end", "path" for a whole-file
+ /// anchor); location is `path:start-end`, `path` for a whole-file
/// anchor ("-" when there is no anchor or the file is gone) —
- /// followed by optional "context <c>" and "parent <id>" lines, then
+ /// followed by optional `context <c>` and `parent <id>` lines, then
/// the body with every line prefixed by one tab.
List {
/// Project each anchor onto the working tree's on-disk bytes
@@ -38,7 +38,7 @@
#[facet(args::named, default)]
open: bool,
/// Keep only comments naming this context (a ref path below
- /// refs/meta/, e.g. issues/<id>).
+ /// refs/meta/, e.g. `issues/<id>`).
#[facet(args::named)]
context: Option<String>,
/// Emit the stable machine-readable form described above.
@@ -69,7 +69,7 @@
#[facet(args::named, default)]
worktree: bool,
/// Canonical ref path below refs/meta/ of the entity this comment
- /// belongs to, e.g. issues/<id> or reviews/<id>.
+ /// belongs to, e.g. `issues/<id>` or `reviews/<id>`.
#[facet(args::named)]
context: Option<String>,
/// Id of the comment this one replies to.
@@ -79,8 +79,9 @@
#[facet(args::named)]
key: Option<PathBuf>,
},
- /// Reply to a comment: a new comment whose parent is <id>, inheriting
- /// its aboutness from the thread — no anchor or context required.
+ /// Reply to a comment: a new comment whose parent is the given id,
+ /// inheriting its aboutness from the thread — no anchor or context
+ /// required.
Reply {
/// The comment being replied to.
#[facet(args::positional)]
crates/forge/ents-forge/src/comment/command.rs
@@ -551,8 +551,7 @@
/// the whole conversation attached to it (`lens.hover`); an anchored root
/// need carry no `context`, so [`thread`]'s context aggregation cannot find
/// its replies — this seeds the same parent-closure walk from the root id
-/// directly. Reads back through the legacy-shape fallback like every other
-/// read here (`meta-ref.migration`).
+/// directly.
///
/// # Errors
///
crates/forge/ents-forge/src/review/cli.rs
@@ -15,8 +15,8 @@
#[repr(u8)]
pub enum ReviewAction {
/// Review a commit: a verdict plus a body, occupying two refs — the
- /// review's own entity ref at refs/meta/reviews/<id>, and a retention
- /// pin at refs/meta/pins/reviews/<id> keeping the reviewed commit (and
+ /// review's own entity ref at `refs/meta/reviews/<id>`, and a retention
+ /// pin at `refs/meta/pins/reviews/<id>` keeping the reviewed commit (and
/// its ancestry) reachable.
New {
/// Revision to review.