From c734380cfe09f15d3f4bcb9964cee033565e4fcc Mon Sep 17 00:00:00 2001 From: naskya Date: Thu, 20 Jun 2024 08:17:13 +0900 Subject: [PATCH] add doc comments --- src/command/config.rs | 2 ++ src/command/config/migrate.rs | 2 ++ src/command/config/migrate/v20240701.rs | 2 ++ src/command/config/validate.rs | 2 ++ src/command/mod.rs | 2 ++ src/command/version.rs | 2 ++ 6 files changed, 12 insertions(+) diff --git a/src/command/config.rs b/src/command/config.rs index 6ed0e91..fdd2d21 100644 --- a/src/command/config.rs +++ b/src/command/config.rs @@ -1,3 +1,5 @@ +//! `config` subcommand + mod migrate; mod validate; diff --git a/src/command/config/migrate.rs b/src/command/config/migrate.rs index efc0567..e72402d 100644 --- a/src/command/config/migrate.rs +++ b/src/command/config/migrate.rs @@ -1,3 +1,5 @@ +//! `config migrate` subcommand + mod v20240701; use super::ConfigVersion; diff --git a/src/command/config/migrate/v20240701.rs b/src/command/config/migrate/v20240701.rs index 078e785..9bf19e0 100644 --- a/src/command/config/migrate/v20240701.rs +++ b/src/command/config/migrate/v20240701.rs @@ -1,3 +1,5 @@ +//! `config migrate 20240701` subcommand + use sqlx::{postgres::PgConnectOptions, ConnectOptions}; use std::{collections::HashMap, env, fs, io::Read}; use yaml_rust::{Yaml, YamlLoader}; diff --git a/src/command/config/validate.rs b/src/command/config/validate.rs index 7bc4668..f2b72df 100644 --- a/src/command/config/validate.rs +++ b/src/command/config/validate.rs @@ -1,3 +1,5 @@ +//! `config validate` subcommand + use crate::config::{client, server}; use std::{env, fs, io::Read}; use validator::{Validate, ValidationErrors}; diff --git a/src/command/mod.rs b/src/command/mod.rs index 1908999..1d57c8f 100644 --- a/src/command/mod.rs +++ b/src/command/mod.rs @@ -1,3 +1,5 @@ +//! Subcommand implementations + pub(crate) mod config; pub(crate) mod version; diff --git a/src/command/version.rs b/src/command/version.rs index 78d4cd7..7e55454 100644 --- a/src/command/version.rs +++ b/src/command/version.rs @@ -1,3 +1,5 @@ +//! `version` subcommand + use color_print::cprintln; pub(crate) fn run() {