Drop period from first line of about texts.

This commit is contained in:
Justus Winter 2024-01-16 14:08:18 +01:00
parent 8ffbb07ebe
commit b68d22dfc8
No known key found for this signature in database
GPG Key ID: 686F55B4AB2B3386
4 changed files with 13 additions and 9 deletions

View File

@ -88,8 +88,10 @@ pub enum Subcommands {
name = "add", name = "add",
about = "Link a certificate and a User ID", about = "Link a certificate and a User ID",
long_about = long_about =
"Link a certificate and a User ID. This cause `sq` to considers "Link a certificate and a User ID
the certificate and User ID binding to be authentic.
This cause `sq` to considers the certificate and User ID binding to be
authentic.
A certificate can also be accepted as a certification authority, which A certificate can also be accepted as a certification authority, which
is also known as a trusted introducer, by using the `--ca` or is also known as a trusted introducer, by using the `--ca` or
@ -322,7 +324,7 @@ pub struct AddCommand {
name = "retract", name = "retract",
about = "Retracts links", about = "Retracts links",
long_about = long_about =
"Retracts links. "Retracts links
This command retracts links that were previously created using `sq This command retracts links that were previously created using `sq
link add`. See that subcommand's documentation for more details. link add`. See that subcommand's documentation for more details.
@ -397,7 +399,7 @@ pub struct RetractCommand {
name = "list", name = "list",
about = "Lists links", about = "Lists links",
long_about = long_about =
"Lists links. "Lists links
This command lists all bindings that are linked or whose link has been This command lists all bindings that are linked or whose link has been
retracted. retracted.

View File

@ -25,6 +25,8 @@
/// ///
/// ## Typography /// ## Typography
/// ///
/// - The first line of the about texts MUST NOT end in a period.
///
/// - To define terms, enclose them in double quotes: "certificate". /// - To define terms, enclose them in double quotes: "certificate".
/// ///
/// - To include inline code fragments, like options or other /// - To include inline code fragments, like options or other

View File

@ -11,7 +11,7 @@ use crate::cli::types::FileOrStdout;
#[clap( #[clap(
name = "dane", name = "dane",
about = "Interacts with DANE", about = "Interacts with DANE",
long_about = "DNS-Based Authentication of Named Entities (DANE) is a method for publishing public keys in DNS as specified in RFC 7929.", long_about = "DNS-Based Authentication of Named Entities (DANE) is a method for publishing public keys in DNS as specified in RFC 7929",
subcommand_required = true, subcommand_required = true,
arg_required_else_help = true, arg_required_else_help = true,
)] )]
@ -28,7 +28,7 @@ pub enum Subcommands {
#[derive(Debug, Args)] #[derive(Debug, Args)]
#[clap( #[clap(
about = "Generates DANE records for the given domain and keys.", about = "Generates DANE records for the given domain and keys",
long_about = long_about =
"Generates DANE records for the given domain and keys "Generates DANE records for the given domain and keys

View File

@ -29,7 +29,7 @@ pub enum Subcommands {
#[derive(Debug, Args)] #[derive(Debug, Args)]
#[clap( #[clap(
about = "Prints the advanced Web Key Directory URL of an email address.", about = "Prints the advanced Web Key Directory URL of an email address",
)] )]
pub struct UrlCommand { pub struct UrlCommand {
#[clap( #[clap(
@ -41,7 +41,7 @@ pub struct UrlCommand {
#[derive(Debug, Args)] #[derive(Debug, Args)]
#[clap( #[clap(
about = "Prints the direct Web Key Directory URL of an email address.", about = "Prints the direct Web Key Directory URL of an email address",
)] )]
pub struct DirectUrlCommand { pub struct DirectUrlCommand {
#[clap( #[clap(
@ -94,7 +94,7 @@ pub struct FetchCommand {
#[derive(Debug, Args)] #[derive(Debug, Args)]
#[clap( #[clap(
about = "Generates a Web Key Directory for the given domain and keys.", about = "Generates a Web Key Directory for the given domain and keys",
long_about = long_about =
"Generates a Web Key Directory for the given domain and keys "Generates a Web Key Directory for the given domain and keys