fix: Remove extraneous dashes from command help

This commit is contained in:
Ginger
2026-01-12 10:47:19 -05:00
parent a028049e6f
commit 00eeeb78de
34 changed files with 314 additions and 314 deletions
+4 -4
View File
@@ -9,7 +9,7 @@ use crate::Context;
#[derive(Debug, Subcommand)]
pub enum RoomAliasCommand {
/// - Make an alias point to a room.
/// Make an alias point to a room.
Set {
#[arg(short, long)]
/// Set the alias even if a room is already using it
@@ -22,20 +22,20 @@ pub enum RoomAliasCommand {
room_alias_localpart: String,
},
/// - Remove a local alias
/// Remove a local alias
Remove {
/// The alias localpart to remove (`alias`, not `#alias:servername.tld`)
room_alias_localpart: String,
},
/// - Show which room is using an alias
/// Show which room is using an alias
Which {
/// The alias localpart to look up (`alias`, not
/// `#alias:servername.tld`)
room_alias_localpart: String,
},
/// - List aliases currently being used
/// List aliases currently being used
List {
/// If set, only list the aliases for this room
room_id: Option<OwnedRoomId>,
+3 -3
View File
@@ -7,19 +7,19 @@ use crate::{Context, PAGE_SIZE, get_room_info};
#[derive(Debug, Subcommand)]
pub enum RoomDirectoryCommand {
/// - Publish a room to the room directory
/// Publish a room to the room directory
Publish {
/// The room id of the room to publish
room_id: OwnedRoomId,
},
/// - Unpublish a room to the room directory
/// Unpublish a room to the room directory
Unpublish {
/// The room id of the room to unpublish
room_id: OwnedRoomId,
},
/// - List rooms that are published
/// List rooms that are published
List {
page: Option<usize>,
},
+2 -2
View File
@@ -8,7 +8,7 @@ use crate::{admin_command, admin_command_dispatch};
#[admin_command_dispatch]
#[derive(Debug, Subcommand)]
pub enum RoomInfoCommand {
/// - List joined members in a room
/// List joined members in a room
ListJoinedMembers {
room_id: OwnedRoomId,
@@ -17,7 +17,7 @@ pub enum RoomInfoCommand {
local_only: bool,
},
/// - Displays room topic
/// Displays room topic
///
/// Room topics can be huge, so this is in its
/// own separate command
+6 -6
View File
@@ -17,7 +17,7 @@ use crate::admin_command_dispatch;
#[admin_command_dispatch]
#[derive(Debug, Subcommand)]
pub enum RoomCommand {
/// - List all rooms the server knows about
/// List all rooms the server knows about
#[clap(alias = "list")]
ListRooms {
page: Option<usize>,
@@ -37,22 +37,22 @@ pub enum RoomCommand {
},
#[command(subcommand)]
/// - View information about a room we know about
/// View information about a room we know about
Info(RoomInfoCommand),
#[command(subcommand)]
/// - Manage moderation of remote or local rooms
/// Manage moderation of remote or local rooms
Moderation(RoomModerationCommand),
#[command(subcommand)]
/// - Manage rooms' aliases
/// Manage rooms' aliases
Alias(RoomAliasCommand),
#[command(subcommand)]
/// - Manage the room directory
/// Manage the room directory
Directory(RoomDirectoryCommand),
/// - Check if we know about a room
/// Check if we know about a room
Exists {
room_id: OwnedRoomId,
},
+4 -4
View File
@@ -13,7 +13,7 @@ use crate::{admin_command, admin_command_dispatch, get_room_info};
#[admin_command_dispatch]
#[derive(Debug, Subcommand)]
pub enum RoomModerationCommand {
/// - Bans a room from local users joining and evicts all our local users
/// Bans a room from local users joining and evicts all our local users
/// (including server
/// admins)
/// from the room. Also blocks any invites (local and remote) for the
@@ -24,19 +24,19 @@ pub enum RoomModerationCommand {
room: OwnedRoomOrAliasId,
},
/// - Bans a list of rooms (room IDs and room aliases) from a newline
/// Bans a list of rooms (room IDs and room aliases) from a newline
/// delimited codeblock similar to `user deactivate-all`. Applies the same
/// steps as ban-room
BanListOfRooms,
/// - Unbans a room to allow local users to join again
/// Unbans a room to allow local users to join again
UnbanRoom {
/// The room in the format of `!roomid:example.com` or a room alias in
/// the format of `#roomalias:example.com`
room: OwnedRoomOrAliasId,
},
/// - List of all rooms we have banned
/// List of all rooms we have banned
ListBannedRooms {
#[arg(long)]
/// Whether to only output room IDs without supplementary room