fix: Remove extraneous dashes from command help

src/admin/admin.rs

@@ -19,43 +19,43 @@ use crate::{
 #[command(name = conduwuit_core::name(), version = conduwuit_core::version())]
 pub enum AdminCommand {
 	#[command(subcommand)]
-	/// - Commands for managing appservices
+	/// Commands for managing appservices
 	Appservices(AppserviceCommand),
 
 	#[command(subcommand)]
-	/// - Commands for managing local users
+	/// Commands for managing local users
 	Users(UserCommand),
 
 	#[command(subcommand)]
-	/// - Commands for managing registration tokens
+	/// Commands for managing registration tokens
 	Token(TokenCommand),
 
 	#[command(subcommand)]
-	/// - Commands for managing rooms
+	/// Commands for managing rooms
 	Rooms(RoomCommand),
 
 	#[command(subcommand)]
-	/// - Commands for managing federation
+	/// Commands for managing federation
 	Federation(FederationCommand),
 
 	#[command(subcommand)]
-	/// - Commands for managing the server
+	/// Commands for managing the server
 	Server(ServerCommand),
 
 	#[command(subcommand)]
-	/// - Commands for managing media
+	/// Commands for managing media
 	Media(MediaCommand),
 
 	#[command(subcommand)]
-	/// - Commands for checking integrity
+	/// Commands for checking integrity
 	Check(CheckCommand),
 
 	#[command(subcommand)]
-	/// - Commands for debugging things
+	/// Commands for debugging things
 	Debug(DebugCommand),
 
 	#[command(subcommand)]
-	/// - Low-level queries for database getters and iterators
+	/// Low-level queries for database getters and iterators
 	Query(QueryCommand),
 }
 

src/admin/appservice/mod.rs

@@ -8,7 +8,7 @@ use crate::admin_command_dispatch;
 #[derive(Debug, Subcommand)]
 #[admin_command_dispatch]
 pub enum AppserviceCommand {
-	/// - Register an appservice using its registration YAML
+	/// Register an appservice using its registration YAML
 	///
 	/// This command needs a YAML generated by an appservice (such as a bridge),
 	/// which must be provided in a Markdown code block below the command.
@@ -17,7 +17,7 @@ pub enum AppserviceCommand {
 	/// the old one.
 	Register,
 
-	/// - Unregister an appservice using its ID
+	/// Unregister an appservice using its ID
 	///
 	/// You can find the ID using the `list-appservices` command.
 	Unregister {
@@ -25,7 +25,7 @@ pub enum AppserviceCommand {
 		appservice_identifier: String,
 	},
 
-	/// - Show an appservice's config using its ID
+	/// Show an appservice's config using its ID
 	///
 	/// You can find the ID using the `list-appservices` command.
 	#[clap(alias("show"))]
@@ -34,7 +34,7 @@ pub enum AppserviceCommand {
 		appservice_identifier: String,
 	},
 
-	/// - List all the currently registered appservices
+	/// List all the currently registered appservices
 	#[clap(alias("list"))]
 	ListRegistered,
 }

src/admin/debug/mod.rs

@@ -12,18 +12,18 @@ use crate::admin_command_dispatch;
 #[admin_command_dispatch]
 #[derive(Debug, Subcommand)]
 pub enum DebugCommand {
-	/// - Echo input of admin command
+	/// Echo input of admin command
 	Echo {
 		message: Vec<String>,
 	},
 
-	/// - Get the auth_chain of a PDU
+	/// Get the auth_chain of a PDU
 	GetAuthChain {
 		/// An event ID (the $ character followed by the base64 reference hash)
 		event_id: OwnedEventId,
 	},
 
-	/// - Parse and print a PDU from a JSON
+	/// Parse and print a PDU from a JSON
 	///
 	/// The PDU event is only checked for validity and is not added to the
 	/// database.
@@ -32,13 +32,13 @@ pub enum DebugCommand {
 	/// the command.
 	ParsePdu,
 
-	/// - Retrieve and print a PDU by EventID from the Continuwuity database
+	/// Retrieve and print a PDU by EventID from the Continuwuity database
 	GetPdu {
 		/// An event ID (a $ followed by the base64 reference hash)
 		event_id: OwnedEventId,
 	},
 
-	/// - Retrieve and print a PDU by PduId from the Continuwuity database
+	/// Retrieve and print a PDU by PduId from the Continuwuity database
 	GetShortPdu {
 		/// Shortroomid integer
 		shortroomid: ShortRoomId,
@@ -47,7 +47,7 @@ pub enum DebugCommand {
 		shorteventid: ShortEventId,
 	},
 
-	/// - Attempts to retrieve a PDU from a remote server. **Does not** insert
+	/// Attempts to retrieve a PDU from a remote server. **Does not** insert
 	///   it into the database
 	/// or persist it anywhere.
 	GetRemotePdu {
@@ -59,7 +59,7 @@ pub enum DebugCommand {
 		server: OwnedServerName,
 	},
 
-	/// - Same as `get-remote-pdu` but accepts a codeblock newline delimited
+	/// Same as `get-remote-pdu` but accepts a codeblock newline delimited
 	///   list of PDUs and a single server to fetch from
 	GetRemotePduList {
 		/// Argument for us to attempt to fetch all the events from the
@@ -71,7 +71,7 @@ pub enum DebugCommand {
 		force: bool,
 	},
 
-	/// - Gets all the room state events for the specified room.
+	/// Gets all the room state events for the specified room.
 	///
 	/// This is functionally equivalent to `GET
 	/// /_matrix/client/v3/rooms/{roomid}/state`, except the admin command does
@@ -86,7 +86,7 @@ pub enum DebugCommand {
 		room_id: OwnedRoomOrAliasId,
 	},
 
-	/// - Get and display signing keys from local cache or remote server.
+	/// Get and display signing keys from local cache or remote server.
 	GetSigningKeys {
 		server_name: Option<OwnedServerName>,
 
@@ -97,23 +97,23 @@ pub enum DebugCommand {
 		query: bool,
 	},
 
-	/// - Get and display signing keys from local cache or remote server.
+	/// Get and display signing keys from local cache or remote server.
 	GetVerifyKeys {
 		server_name: Option<OwnedServerName>,
 	},
 
-	/// - Sends a federation request to the remote server's
+	/// Sends a federation request to the remote server's
 	///   `/_matrix/federation/v1/version` endpoint and measures the latency it
 	///   took for the server to respond
 	Ping {
 		server: OwnedServerName,
 	},
 
-	/// - Forces device lists for all local and remote users to be updated (as
+	/// Forces device lists for all local and remote users to be updated (as
 	///   having new keys available)
 	ForceDeviceListUpdates,
 
-	/// - Change tracing log level/filter on the fly
+	/// Change tracing log level/filter on the fly
 	///
 	/// This accepts the same format as the `log` config option.
 	ChangeLogLevel {
@@ -125,34 +125,34 @@ pub enum DebugCommand {
 		reset: bool,
 	},
 
-	/// - Verify JSON signatures
+	/// Verify JSON signatures
 	///
 	/// This command needs a JSON blob provided in a Markdown code block below
 	/// the command.
 	VerifyJson,
 
-	/// - Verify PDU
+	/// Verify PDU
 	///
 	/// This re-verifies a PDU existing in the database found by ID.
 	VerifyPdu {
 		event_id: OwnedEventId,
 	},
 
-	/// - Prints the very first PDU in the specified room (typically
+	/// Prints the very first PDU in the specified room (typically
 	///   m.room.create)
 	FirstPduInRoom {
 		/// The room ID
 		room_id: OwnedRoomId,
 	},
 
-	/// - Prints the latest ("last") PDU in the specified room (typically a
+	/// Prints the latest ("last") PDU in the specified room (typically a
 	///   message)
 	LatestPduInRoom {
 		/// The room ID
 		room_id: OwnedRoomId,
 	},
 
-	/// - Forcefully replaces the room state of our local copy of the specified
+	/// Forcefully replaces the room state of our local copy of the specified
 	///   room, with the copy (auth chain and room state events) the specified
 	///   remote server says.
 	///
@@ -176,7 +176,7 @@ pub enum DebugCommand {
 		event_id: Option<OwnedEventId>,
 	},
 
-	/// - Runs a server name through Continuwuity's true destination resolution
+	/// Runs a server name through Continuwuity's true destination resolution
 	///   process
 	///
 	/// Useful for debugging well-known issues
@@ -187,7 +187,7 @@ pub enum DebugCommand {
 		no_cache: bool,
 	},
 
-	/// - Print extended memory usage
+	/// Print extended memory usage
 	///
 	/// Optional argument is a character mask (a sequence of characters in any
 	/// order) which enable additional extended statistics. Known characters are
@@ -196,23 +196,23 @@ pub enum DebugCommand {
 		opts: Option<String>,
 	},
 
-	/// - Print general tokio runtime metric totals.
+	/// Print general tokio runtime metric totals.
 	RuntimeMetrics,
 
-	/// - Print detailed tokio runtime metrics accumulated since last command
+	/// Print detailed tokio runtime metrics accumulated since last command
 	///   invocation.
 	RuntimeInterval,
 
-	/// - Print the current time
+	/// Print the current time
 	Time,
 
-	/// - List dependencies
+	/// List dependencies
 	ListDependencies {
 		#[arg(short, long)]
 		names: bool,
 	},
 
-	/// - Get database statistics
+	/// Get database statistics
 	DatabaseStats {
 		property: Option<String>,
 
@@ -220,10 +220,10 @@ pub enum DebugCommand {
 		map: Option<String>,
 	},
 
-	/// - Trim memory usage
+	/// Trim memory usage
 	TrimMemory,
 
-	/// - List database files
+	/// List database files
 	DatabaseFiles {
 		map: Option<String>,
 
@@ -231,7 +231,7 @@ pub enum DebugCommand {
 		level: Option<i32>,
 	},
 
-	/// - Developer test stubs
+	/// Developer test stubs
 	#[command(subcommand)]
 	#[allow(non_snake_case)]
 	#[clap(hide(true))]

src/admin/federation/mod.rs

@@ -9,20 +9,20 @@ use crate::admin_command_dispatch;
 #[admin_command_dispatch]
 #[derive(Debug, Subcommand)]
 pub enum FederationCommand {
-	/// - List all rooms we are currently handling an incoming pdu from
+	/// List all rooms we are currently handling an incoming pdu from
 	IncomingFederation,
 
-	/// - Disables incoming federation handling for a room.
+	/// Disables incoming federation handling for a room.
 	DisableRoom {
 		room_id: OwnedRoomId,
 	},
 
-	/// - Enables incoming federation handling for a room again.
+	/// Enables incoming federation handling for a room again.
 	EnableRoom {
 		room_id: OwnedRoomId,
 	},
 
-	/// - Fetch `/.well-known/matrix/support` from the specified server
+	/// Fetch `/.well-known/matrix/support` from the specified server
 	///
 	/// Despite the name, this is not a federation endpoint and does not go
 	/// through the federation / server resolution process as per-spec this is
@@ -35,7 +35,7 @@ pub enum FederationCommand {
 		server_name: OwnedServerName,
 	},
 
-	/// - Lists all the rooms we share/track with the specified *remote* user
+	/// Lists all the rooms we share/track with the specified *remote* user
 	RemoteUserInRooms {
 		user_id: OwnedUserId,
 	},

src/admin/media/mod.rs

@@ -10,20 +10,20 @@ use crate::admin_command_dispatch;
 #[admin_command_dispatch]
 #[derive(Debug, Subcommand)]
 pub enum MediaCommand {
-	/// - Deletes a single media file from our database and on the filesystem
+	/// Deletes a single media file from our database and on the filesystem
 	///   via a single MXC URL or event ID (not redacted)
 	Delete {
 		/// The MXC URL to delete
 		#[arg(long)]
 		mxc: Option<OwnedMxcUri>,
 
-		/// - The message event ID which contains the media and thumbnail MXC
+		/// The message event ID which contains the media and thumbnail MXC
 		///   URLs
 		#[arg(long)]
 		event_id: Option<OwnedEventId>,
 	},
 
-	/// - Deletes a codeblock list of MXC URLs from our database and on the
+	/// Deletes a codeblock list of MXC URLs from our database and on the
 	///   filesystem. This will always ignore errors.
 	DeleteList,
 
@@ -40,33 +40,33 @@ pub enum MediaCommand {
 	///   * Delete all remote and local media from 3 days ago, up until now:
 	///
 	///     `!admin media delete-past-remote-media -a 3d
-	/// --yes-i-want-to-delete-local-media`
+	///-yes-i-want-to-delete-local-media`
 	#[command(verbatim_doc_comment)]
 	DeletePastRemoteMedia {
-		/// - The relative time (e.g. 30s, 5m, 7d) from now within which to
+		/// The relative time (e.g. 30s, 5m, 7d) from now within which to
 		///   search
 		duration: String,
 
-		/// - Only delete media created before [duration] ago
+		/// Only delete media created before [duration] ago
 		#[arg(long, short)]
 		before: bool,
 
-		/// - Only delete media created after [duration] ago
+		/// Only delete media created after [duration] ago
 		#[arg(long, short)]
 		after: bool,
 
-		/// - Long argument to additionally delete local media
+		/// Long argument to additionally delete local media
 		#[arg(long)]
 		yes_i_want_to_delete_local_media: bool,
 	},
 
-	/// - Deletes all the local media from a local user on our server. This will
+	/// Deletes all the local media from a local user on our server. This will
 	///   always ignore errors by default.
 	DeleteAllFromUser {
 		username: String,
 	},
 
-	/// - Deletes all remote media from the specified remote server. This will
+	/// Deletes all remote media from the specified remote server. This will
 	///   always ignore errors by default.
 	DeleteAllFromServer {
 		server_name: OwnedServerName,

src/admin/query/account_data.rs

@@ -9,7 +9,7 @@ use crate::{admin_command, admin_command_dispatch};
 #[derive(Debug, Subcommand)]
 /// All the getters and iterators from src/database/key_value/account_data.rs
 pub enum AccountDataCommand {
-	/// - Returns all changes to the account data that happened after `since`.
+	/// Returns all changes to the account data that happened after `since`.
 	ChangesSince {
 		/// Full user ID
 		user_id: OwnedUserId,
@@ -19,7 +19,7 @@ pub enum AccountDataCommand {
 		room_id: Option<OwnedRoomId>,
 	},
 
-	/// - Searches the account data for a specific kind.
+	/// Searches the account data for a specific kind.
 	AccountDataGet {
 		/// Full user ID
 		user_id: OwnedUserId,

src/admin/query/appservice.rs

@@ -7,13 +7,13 @@ use crate::Context;
 #[derive(Debug, Subcommand)]
 /// All the getters and iterators from src/database/key_value/appservice.rs
 pub enum AppserviceCommand {
-	/// - Gets the appservice registration info/details from the ID as a string
+	/// Gets the appservice registration info/details from the ID as a string
 	GetRegistration {
 		/// Appservice registration ID
 		appservice_id: String,
 	},
 
-	/// - Gets all appservice registrations with their ID and registration info
+	/// Gets all appservice registrations with their ID and registration info
 	All,
 }
 

src/admin/query/globals.rs

@@ -13,7 +13,7 @@ pub enum GlobalsCommand {
 
 	LastCheckForAnnouncementsId,
 
-	/// - This returns an empty `Ok(BTreeMap<..>)` when there are no keys found
+	/// This returns an empty `Ok(BTreeMap<..>)` when there are no keys found
 	///   for the server.
 	SigningKeysFor {
 		origin: OwnedServerName,

src/admin/query/mod.rs

@@ -28,55 +28,55 @@ use crate::admin_command_dispatch;
 #[derive(Debug, Subcommand)]
 /// Query tables from database
 pub enum QueryCommand {
-	/// - account_data.rs iterators and getters
+	/// account_data.rs iterators and getters
 	#[command(subcommand)]
 	AccountData(AccountDataCommand),
 
-	/// - appservice.rs iterators and getters
+	/// appservice.rs iterators and getters
 	#[command(subcommand)]
 	Appservice(AppserviceCommand),
 
-	/// - presence.rs iterators and getters
+	/// presence.rs iterators and getters
 	#[command(subcommand)]
 	Presence(PresenceCommand),
 
-	/// - rooms/alias.rs iterators and getters
+	/// rooms/alias.rs iterators and getters
 	#[command(subcommand)]
 	RoomAlias(RoomAliasCommand),
 
-	/// - rooms/state_cache iterators and getters
+	/// rooms/state_cache iterators and getters
 	#[command(subcommand)]
 	RoomStateCache(RoomStateCacheCommand),
 
-	/// - rooms/timeline iterators and getters
+	/// rooms/timeline iterators and getters
 	#[command(subcommand)]
 	RoomTimeline(RoomTimelineCommand),
 
-	/// - globals.rs iterators and getters
+	/// globals.rs iterators and getters
 	#[command(subcommand)]
 	Globals(GlobalsCommand),
 
-	/// - sending.rs iterators and getters
+	/// sending.rs iterators and getters
 	#[command(subcommand)]
 	Sending(SendingCommand),
 
-	/// - users.rs iterators and getters
+	/// users.rs iterators and getters
 	#[command(subcommand)]
 	Users(UsersCommand),
 
-	/// - resolver service
+	/// resolver service
 	#[command(subcommand)]
 	Resolver(ResolverCommand),
 
-	/// - pusher service
+	/// pusher service
 	#[command(subcommand)]
 	Pusher(PusherCommand),
 
-	/// - short service
+	/// short service
 	#[command(subcommand)]
 	Short(ShortCommand),
 
-	/// - raw service
+	/// raw service
 	#[command(subcommand)]
 	Raw(RawCommand),
 }

src/admin/query/presence.rs

@@ -8,13 +8,13 @@ use crate::Context;
 #[derive(Debug, Subcommand)]
 /// All the getters and iterators from src/database/key_value/presence.rs
 pub enum PresenceCommand {
-	/// - Returns the latest presence event for the given user.
+	/// Returns the latest presence event for the given user.
 	GetPresence {
 		/// Full user ID
 		user_id: OwnedUserId,
 	},
 
-	/// - Iterator of the most recent presence updates that happened after the
+	/// Iterator of the most recent presence updates that happened after the
 	///   event with id `since`.
 	PresenceSince {
 		/// UNIX timestamp since (u64)

src/admin/query/pusher.rs

@@ -6,7 +6,7 @@ use crate::Context;
 
 #[derive(Debug, Subcommand)]
 pub enum PusherCommand {
-	/// - Returns all the pushers for the user.
+	/// Returns all the pushers for the user.
 	GetPushers {
 		/// Full user ID
 		user_id: OwnedUserId,

src/admin/query/raw.rs

@@ -20,10 +20,10 @@ use crate::{admin_command, admin_command_dispatch};
 #[allow(clippy::enum_variant_names)]
 /// Query tables from database
 pub enum RawCommand {
-	/// - List database maps
+	/// List database maps
 	RawMaps,
 
-	/// - Raw database query
+	/// Raw database query
 	RawGet {
 		/// Map name
 		map: String,
@@ -32,7 +32,7 @@ pub enum RawCommand {
 		key: String,
 	},
 
-	/// - Raw database delete (for string keys)
+	/// Raw database delete (for string keys)
 	RawDel {
 		/// Map name
 		map: String,
@@ -41,7 +41,7 @@ pub enum RawCommand {
 		key: String,
 	},
 
-	/// - Raw database keys iteration
+	/// Raw database keys iteration
 	RawKeys {
 		/// Map name
 		map: String,
@@ -50,7 +50,7 @@ pub enum RawCommand {
 		prefix: Option<String>,
 	},
 
-	/// - Raw database key size breakdown
+	/// Raw database key size breakdown
 	RawKeysSizes {
 		/// Map name
 		map: Option<String>,
@@ -59,7 +59,7 @@ pub enum RawCommand {
 		prefix: Option<String>,
 	},
 
-	/// - Raw database keys total bytes
+	/// Raw database keys total bytes
 	RawKeysTotal {
 		/// Map name
 		map: Option<String>,
@@ -68,7 +68,7 @@ pub enum RawCommand {
 		prefix: Option<String>,
 	},
 
-	/// - Raw database values size breakdown
+	/// Raw database values size breakdown
 	RawValsSizes {
 		/// Map name
 		map: Option<String>,
@@ -77,7 +77,7 @@ pub enum RawCommand {
 		prefix: Option<String>,
 	},
 
-	/// - Raw database values total bytes
+	/// Raw database values total bytes
 	RawValsTotal {
 		/// Map name
 		map: Option<String>,
@@ -86,7 +86,7 @@ pub enum RawCommand {
 		prefix: Option<String>,
 	},
 
-	/// - Raw database items iteration
+	/// Raw database items iteration
 	RawIter {
 		/// Map name
 		map: String,
@@ -95,7 +95,7 @@ pub enum RawCommand {
 		prefix: Option<String>,
 	},
 
-	/// - Raw database keys iteration
+	/// Raw database keys iteration
 	RawKeysFrom {
 		/// Map name
 		map: String,
@@ -108,7 +108,7 @@ pub enum RawCommand {
 		limit: Option<usize>,
 	},
 
-	/// - Raw database items iteration
+	/// Raw database items iteration
 	RawIterFrom {
 		/// Map name
 		map: String,
@@ -121,7 +121,7 @@ pub enum RawCommand {
 		limit: Option<usize>,
 	},
 
-	/// - Raw database record count
+	/// Raw database record count
 	RawCount {
 		/// Map name
 		map: Option<String>,
@@ -130,7 +130,7 @@ pub enum RawCommand {
 		prefix: Option<String>,
 	},
 
-	/// - Compact database
+	/// Compact database
 	Compact {
 		#[arg(short, long, alias("column"))]
 		map: Option<Vec<String>>,

src/admin/query/room_alias.rs

@@ -13,13 +13,13 @@ pub enum RoomAliasCommand {
 		alias: OwnedRoomAliasId,
 	},
 
-	/// - Iterator of all our local room aliases for the room ID
+	/// Iterator of all our local room aliases for the room ID
 	LocalAliasesForRoom {
 		/// Full room ID
 		room_id: OwnedRoomId,
 	},
 
-	/// - Iterator of all our local aliases in our database with their room IDs
+	/// Iterator of all our local aliases in our database with their room IDs
 	AllLocalAliases,
 }
 

src/admin/query/sending.rs

@@ -9,10 +9,10 @@ use crate::Context;
 #[derive(Debug, Subcommand)]
 /// All the getters and iterators from src/database/key_value/sending.rs
 pub enum SendingCommand {
-	/// - Queries database for all `servercurrentevent_data`
+	/// Queries database for all `servercurrentevent_data`
 	ActiveRequests,
 
-	/// - Queries database for `servercurrentevent_data` but for a specific
+	/// Queries database for `servercurrentevent_data` but for a specific
 	///   destination
 	///
 	/// This command takes only *one* format of these arguments:
@@ -34,7 +34,7 @@ pub enum SendingCommand {
 		push_key: Option<String>,
 	},
 
-	/// - Queries database for `servernameevent_data` which are the queued up
+	/// Queries database for `servernameevent_data` which are the queued up
 	///   requests that will eventually be sent
 	///
 	/// This command takes only *one* format of these arguments:

src/admin/room/alias.rs

@@ -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>,

src/admin/room/directory.rs

@@ -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>,
 	},

src/admin/room/info.rs

@@ -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

src/admin/room/mod.rs

@@ -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,
 	},

src/admin/room/moderation.rs

@@ -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

src/admin/server/mod.rs

@@ -10,18 +10,18 @@ use crate::admin_command_dispatch;
 #[admin_command_dispatch]
 #[derive(Debug, Subcommand)]
 pub enum ServerCommand {
-	/// - Time elapsed since startup
+	/// Time elapsed since startup
 	Uptime,
 
-	/// - Show configuration values
+	/// Show configuration values
 	ShowConfig,
 
-	/// - Reload configuration values
+	/// Reload configuration values
 	ReloadConfig {
 		path: Option<PathBuf>,
 	},
 
-	/// - List the features built into the server
+	/// List the features built into the server
 	ListFeatures {
 		#[arg(short, long)]
 		available: bool,
@@ -33,35 +33,35 @@ pub enum ServerCommand {
 		comma: bool,
 	},
 
-	/// - Print database memory usage statistics
+	/// Print database memory usage statistics
 	MemoryUsage,
 
-	/// - Clears all of Continuwuity's caches
+	/// Clears all of Continuwuity's caches
 	ClearCaches,
 
-	/// - Performs an online backup of the database (only available for RocksDB
+	/// Performs an online backup of the database (only available for RocksDB
 	///   at the moment)
 	BackupDatabase,
 
-	/// - List database backups
+	/// List database backups
 	ListBackups,
 
-	/// - Send a message to the admin room.
+	/// Send a message to the admin room.
 	AdminNotice {
 		message: Vec<String>,
 	},
 
-	/// - Hot-reload the server
+	/// Hot-reload the server
 	#[clap(alias = "reload")]
 	ReloadMods,
 
 	#[cfg(unix)]
-	/// - Restart the server
+	/// Restart the server
 	Restart {
 		#[arg(short, long)]
 		force: bool,
 	},
 
-	/// - Shutdown the server
+	/// Shutdown the server
 	Shutdown,
 }

src/admin/token/mod.rs

@@ -8,7 +8,7 @@ use crate::admin_command_dispatch;
 #[admin_command_dispatch]
 #[derive(Debug, Subcommand)]
 pub enum TokenCommand {
-	/// - Issue a new registration token
+	/// Issue a new registration token
 	#[clap(name = "issue")]
 	IssueToken {
 		/// When this token will expire.
@@ -16,14 +16,14 @@ pub enum TokenCommand {
 		expires: TokenExpires,
 	},
 
-	/// - Revoke a registration token
+	/// Revoke a registration token
 	#[clap(name = "revoke")]
 	RevokeToken {
 		/// The token to revoke.
 		token: String,
 	},
 
-	/// - List all registration tokens
+	/// List all registration tokens
 	#[clap(name = "list")]
 	ListTokens,
 }

src/admin/user/mod.rs

@@ -9,7 +9,7 @@ use crate::admin_command_dispatch;
 #[admin_command_dispatch]
 #[derive(Debug, Subcommand)]
 pub enum UserCommand {
-	/// - Create a new user
+	/// Create a new user
 	#[clap(alias = "create")]
 	CreateUser {
 		/// Username of the new user
@@ -18,7 +18,7 @@ pub enum UserCommand {
 		password: Option<String>,
 	},
 
-	/// - Reset user password
+	/// Reset user password
 	ResetPassword {
 		/// Log out existing sessions
 		#[arg(short, long)]
@@ -29,7 +29,7 @@ pub enum UserCommand {
 		password: Option<String>,
 	},
 
-	/// - Deactivate a user
+	/// Deactivate a user
 	///
 	/// User will be removed from all rooms by default.
 	/// Use --no-leave-rooms to not leave all rooms by default.
@@ -39,7 +39,7 @@ pub enum UserCommand {
 		user_id: String,
 	},
 
-	/// - Deactivate a list of users
+	/// Deactivate a list of users
 	///
 	/// Recommended to use in conjunction with list-local-users.
 	///
@@ -62,7 +62,7 @@ pub enum UserCommand {
 		force: bool,
 	},
 
-	/// - Forcefully log a user out of all of their devices.
+	/// Forcefully log a user out of all of their devices.
 	///
 	/// This will invalidate all access tokens for the specified user,
 	/// effectively logging them out from all sessions.
@@ -74,7 +74,7 @@ pub enum UserCommand {
 		user_id: String,
 	},
 
-	/// - Suspend a user
+	/// Suspend a user
 	///
 	/// Suspended users are able to log in, sync, and read messages, but are not
 	/// able to send events nor redact them, cannot change their profile, and
@@ -87,7 +87,7 @@ pub enum UserCommand {
 		user_id: String,
 	},
 
-	/// - Unsuspend a user
+	/// Unsuspend a user
 	///
 	/// Reverses the effects of the `suspend` command, allowing the user to send
 	/// messages, change their profile, create room invites, etc.
@@ -96,7 +96,7 @@ pub enum UserCommand {
 		user_id: String,
 	},
 
-	/// - Lock a user
+	/// Lock a user
 	///
 	/// Locked users are unable to use their accounts beyond logging out. This
 	/// is akin to a temporary deactivation that does not change the user's
@@ -107,7 +107,7 @@ pub enum UserCommand {
 		user_id: String,
 	},
 
-	/// - Unlock a user
+	/// Unlock a user
 	///
 	/// Reverses the effects of the `lock` command, allowing the user to use
 	/// their account again.
@@ -116,13 +116,13 @@ pub enum UserCommand {
 		user_id: String,
 	},
 
-	/// - Enable login for a user
+	/// Enable login for a user
 	EnableLogin {
 		/// Username of the user to enable login for
 		user_id: String,
 	},
 
-	/// - Disable login for a user
+	/// Disable login for a user
 	///
 	/// Disables login for the specified user without deactivating or locking
 	/// their account. This prevents the user from obtaining new access tokens,
@@ -132,48 +132,48 @@ pub enum UserCommand {
 		user_id: String,
 	},
 
-	/// - List local users in the database
+	/// List local users in the database
 	#[clap(alias = "list")]
 	ListUsers,
 
-	/// - Lists all the rooms (local and remote) that the specified user is
+	/// Lists all the rooms (local and remote) that the specified user is
 	///   joined in
 	ListJoinedRooms {
 		user_id: String,
 	},
 
-	/// - Manually join a local user to a room.
+	/// Manually join a local user to a room.
 	ForceJoinRoom {
 		user_id: String,
 		room_id: OwnedRoomOrAliasId,
 	},
 
-	/// - Manually leave a local user from a room.
+	/// Manually leave a local user from a room.
 	ForceLeaveRoom {
 		user_id: String,
 		room_id: OwnedRoomOrAliasId,
 	},
 
-	/// - Manually leave a remote room for a local user.
+	/// Manually leave a remote room for a local user.
 	ForceLeaveRemoteRoom {
 		user_id: String,
 		room_id: OwnedRoomOrAliasId,
 		via: Option<String>,
 	},
 
-	/// - Forces the specified user to drop their power levels to the room
+	/// Forces the specified user to drop their power levels to the room
 	///   default, if their permissions allow and the auth check permits
 	ForceDemote {
 		user_id: String,
 		room_id: OwnedRoomOrAliasId,
 	},
 
-	/// - Grant server-admin privileges to a user.
+	/// Grant server-admin privileges to a user.
 	MakeUserAdmin {
 		user_id: String,
 	},
 
-	/// - Puts a room tag for the specified user and room ID.
+	/// Puts a room tag for the specified user and room ID.
 	///
 	/// This is primarily useful if you'd like to set your admin room
 	/// to the special "System Alerts" section in Element as a way to
@@ -186,20 +186,20 @@ pub enum UserCommand {
 		tag: String,
 	},
 
-	/// - Deletes the room tag for the specified user and room ID
+	/// Deletes the room tag for the specified user and room ID
 	DeleteRoomTag {
 		user_id: String,
 		room_id: OwnedRoomId,
 		tag: String,
 	},
 
-	/// - Gets all the room tags for the specified user and room ID
+	/// Gets all the room tags for the specified user and room ID
 	GetRoomTags {
 		user_id: String,
 		room_id: OwnedRoomId,
 	},
 
-	/// - Attempts to forcefully redact the specified event ID from the sender
+	/// Attempts to forcefully redact the specified event ID from the sender
 	///   user
 	///
 	/// This is only valid for local users
@@ -207,7 +207,7 @@ pub enum UserCommand {
 		event_id: OwnedEventId,
 	},
 
-	/// - Force joins a specified list of local users to join the specified
+	/// Force joins a specified list of local users to join the specified
 	///   room.
 	///
 	/// Specify a codeblock of usernames.
@@ -222,7 +222,7 @@ pub enum UserCommand {
 		yes_i_want_to_do_this: bool,
 	},
 
-	/// - Force joins all local users to the specified room.
+	/// Force joins all local users to the specified room.
 	///
 	/// At least 1 server admin must be in the room to reduce abuse.
 	///