From 730c9386f66b6348c64a268ef37e752343d8fb9a Mon Sep 17 00:00:00 2001 From: Spencer Gilbert Date: Fri, 14 Apr 2023 15:56:20 -0400 Subject: [PATCH] docs: Adjust doc comment locations (#17154) --- src/sinks/webhdfs/config.rs | 32 -------------------------------- src/sinks/webhdfs/mod.rs | 32 +++++++++++++++++++++++++++++++- 2 files changed, 31 insertions(+), 33 deletions(-) diff --git a/src/sinks/webhdfs/config.rs b/src/sinks/webhdfs/config.rs index 2da440e240274..c961672dcd549 100644 --- a/src/sinks/webhdfs/config.rs +++ b/src/sinks/webhdfs/config.rs @@ -21,38 +21,6 @@ use crate::{ }; /// Configuration for the `webhdfs` sink. -/// -/// The Hadoop Distributed File System (HDFS) is a distributed file system -/// designed to run on commodity hardware. HDFS consists of a namenode and a -/// datanode. We will send rpc to namenode to know which datanode to send -/// and receive data to. Also, HDFS will rebalance data across the cluster -/// to make sure each file has enough redundancy. -/// -/// ```txt -/// ┌───────────────┐ -/// │ Data Node 2 │ -/// └───────────────┘ -/// ▲ -/// ┌───────────────┐ │ ┌───────────────┐ -/// │ Data Node 1 │◄──────────┼───────────►│ Data Node 3 │ -/// └───────────────┘ │ └───────────────┘ -/// ┌───────┴───────┐ -/// │ Name Node │ -/// └───────────────┘ -/// ▲ -/// │ -/// ┌──────┴─────┐ -/// │ Vector │ -/// └────────────┘ -/// ``` -/// -/// WebHDFS will connect to the HTTP RESTful API of HDFS. -/// -/// For more information, please refer to: -/// -/// - [HDFS Users Guide](https://hadoop.apache.org/docs/stable/hadoop-project-dist/hadoop-hdfs/HdfsUserGuide.html) -/// - [WebHDFS REST API](https://hadoop.apache.org/docs/stable/hadoop-project-dist/hadoop-hdfs/WebHDFS.html) -/// - [opendal::services::webhdfs](https://docs.rs/opendal/latest/opendal/services/struct.Webhdfs.html) #[configurable_component(sink("webhdfs"))] #[derive(Clone, Debug)] #[serde(deny_unknown_fields)] diff --git a/src/sinks/webhdfs/mod.rs b/src/sinks/webhdfs/mod.rs index 0bbc04f501569..defe2dfba708a 100644 --- a/src/sinks/webhdfs/mod.rs +++ b/src/sinks/webhdfs/mod.rs @@ -1,6 +1,36 @@ //! `webhdfs` sink. //! -//! This sink will send it's output to WEBHDFS. +//! The Hadoop Distributed File System (HDFS) is a distributed file system +//! designed to run on commodity hardware. HDFS consists of a namenode and a +//! datanode. We will send rpc to namenode to know which datanode to send +//! and receive data to. Also, HDFS will rebalance data across the cluster +//! to make sure each file has enough redundancy. +//! +//! ```txt +//! ┌───────────────┐ +//! │ Data Node 2 │ +//! └───────────────┘ +//! ▲ +//! ┌───────────────┐ │ ┌───────────────┐ +//! │ Data Node 1 │◄──────────┼───────────►│ Data Node 3 │ +//! └───────────────┘ │ └───────────────┘ +//! ┌───────┴───────┐ +//! │ Name Node │ +//! └───────────────┘ +//! ▲ +//! │ +//! ┌──────┴─────┐ +//! │ Vector │ +//! └────────────┘ +//! ``` +//! +//! WebHDFS will connect to the HTTP RESTful API of HDFS. +//! +//! For more information, please refer to: +//! +//! - [HDFS Users Guide](https://hadoop.apache.org/docs/stable/hadoop-project-dist/hadoop-hdfs/HdfsUserGuide.html) +//! - [WebHDFS REST API](https://hadoop.apache.org/docs/stable/hadoop-project-dist/hadoop-hdfs/WebHDFS.html) +//! - [opendal::services::webhdfs](https://docs.rs/opendal/latest/opendal/services/struct.Webhdfs.html) //! //! `webhdfs` is an OpenDal based services. This mod itself only provide //! config to build an [`crate::sinks::opendal_common::OpenDalSink`]. All real implement are powered by