From e29925155d14122bc75a02325947f0e56fdc6129 Mon Sep 17 00:00:00 2001 From: "Dustin J. Mitchell" Date: Wed, 27 Dec 2023 20:02:23 -0500 Subject: [PATCH] Fix formatting of comments in taskchampion.h (#3228) --- taskchampion/lib/src/lib.rs | 15 ++++++++------- taskchampion/lib/taskchampion.h | 15 ++++++++------- 2 files changed, 16 insertions(+), 14 deletions(-) diff --git a/taskchampion/lib/src/lib.rs b/taskchampion/lib/src/lib.rs index 5bd7b9fdf..4039c73d5 100644 --- a/taskchampion/lib/src/lib.rs +++ b/taskchampion/lib/src/lib.rs @@ -39,18 +39,19 @@ ffizz_header::snippet! { /// /// # Overview /// -/// This library defines two major types used to interact with the API, that map directly to Rust +/// This library defines four major types used to interact with the API, that map directly to Rust /// types. /// -/// * TCReplica - see https://docs.rs/taskchampion/latest/taskchampion/struct.Replica.html * TCTask -/// - see https://docs.rs/taskchampion/latest/taskchampion/struct.Task.html * TCServer - see -/// https://docs.rs/taskchampion/latest/taskchampion/trait.Server.html * TCWorkingSet - see -/// https://docs.rs/taskchampion/latest/taskchampion/struct.WorkingSet.html +/// * TCReplica - see https://docs.rs/taskchampion/latest/taskchampion/struct.Replica.html +/// * TCTask - see https://docs.rs/taskchampion/latest/taskchampion/struct.Task.html +/// * TCServer - see https://docs.rs/taskchampion/latest/taskchampion/trait.Server.html +/// * TCWorkingSet - see https://docs.rs/taskchampion/latest/taskchampion/struct.WorkingSet.html /// /// It also defines a few utility types: /// -/// * TCString - a wrapper around both C (NUL-terminated) and Rust (always utf-8) strings. * -/// TC…List - a list of objects represented as a C array * see below for the remainder +/// * TCString - a wrapper around both C (NUL-terminated) and Rust (always utf-8) strings. +/// * TC…List - a list of objects represented as a C array +/// * see below for the remainder /// /// # Safety /// diff --git a/taskchampion/lib/taskchampion.h b/taskchampion/lib/taskchampion.h index 82cabdd8e..1697cad33 100644 --- a/taskchampion/lib/taskchampion.h +++ b/taskchampion/lib/taskchampion.h @@ -7,18 +7,19 @@ // // # Overview // -// This library defines two major types used to interact with the API, that map directly to Rust +// This library defines four major types used to interact with the API, that map directly to Rust // types. // -// * TCReplica - see https://docs.rs/taskchampion/latest/taskchampion/struct.Replica.html * TCTask -// - see https://docs.rs/taskchampion/latest/taskchampion/struct.Task.html * TCServer - see -// https://docs.rs/taskchampion/latest/taskchampion/trait.Server.html * TCWorkingSet - see -// https://docs.rs/taskchampion/latest/taskchampion/struct.WorkingSet.html +// * TCReplica - see https://docs.rs/taskchampion/latest/taskchampion/struct.Replica.html +// * TCTask - see https://docs.rs/taskchampion/latest/taskchampion/struct.Task.html +// * TCServer - see https://docs.rs/taskchampion/latest/taskchampion/trait.Server.html +// * TCWorkingSet - see https://docs.rs/taskchampion/latest/taskchampion/struct.WorkingSet.html // // It also defines a few utility types: // -// * TCString - a wrapper around both C (NUL-terminated) and Rust (always utf-8) strings. * -// TC…List - a list of objects represented as a C array * see below for the remainder +// * TCString - a wrapper around both C (NUL-terminated) and Rust (always utf-8) strings. +// * TC…List - a list of objects represented as a C array +// * see below for the remainder // // # Safety //