chore: modify comments

GreptimeTeam · Oct 8, 2023 · 1cd4af2 · 1cd4af2
1 parent ab70f60
commit 1cd4af2
Show file tree

Hide file tree

Showing 5 changed files with 2 additions and 8 deletions.
diff --git a/src/auth/Cargo.toml b/src/auth/Cargo.toml
@@ -4,8 +4,6 @@ version.workspace = true
 edition.workspace = true
 license.workspace = true
 
-# See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
-
 [features]
 default = []
 testing = []

diff --git a/src/frontend/src/instance.rs b/src/frontend/src/instance.rs
@@ -122,8 +122,6 @@ pub struct Instance {
     script_executor: Arc<ScriptExecutor>,
     statement_executor: Arc<StatementExecutor>,
     query_engine: QueryEngineRef,
-    /// plugins: this map holds extensions to customize query or auth
-    /// behaviours.
     plugins: PluginsRef,
     servers: Arc<ServerHandlers>,
     heartbeat_task: Option<HeartbeatTask>,

diff --git a/src/partition/Cargo.toml b/src/partition/Cargo.toml
@@ -4,8 +4,6 @@ version.workspace = true
 edition.workspace = true
 license.workspace = true
 
-# See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
-
 [dependencies]
 api = { workspace = true }
 async-trait = "0.1"

diff --git a/src/plugins/Cargo.toml b/src/plugins/Cargo.toml
@@ -4,8 +4,6 @@ version.workspace = true
 edition.workspace = true
 license.workspace = true
 
-# See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
-
 [dependencies]
 auth.workspace = true
 common-base.workspace = true

diff --git a/src/plugins/src/lib.rs b/src/plugins/src/lib.rs
@@ -21,6 +21,8 @@ pub use datanode::{setup_datanode_plugins, start_datanode_plugins};
 pub use frontend::{setup_frontend_plugins, start_frontend_plugins};
 pub use meta_srv::{setup_meta_srv_plugins, start_meta_srv_plugins};
 
+/// [`OptPlugins`] is a wrapper around [`PluginsRef`] and opts returned by setup functions.
+/// T can be [`DatanodeOptions`], [`FrontendOptions`] or [`MetaSrvOptions`].
 pub struct OptPlugins<T> {
     pub opts: T,
     pub plugins: PluginsRef,