apache / hudi-rs

A native Rust library for Apache Hudi, with bindings into Python
https://hudi.apache.org/
Apache License 2.0
153 stars 32 forks source link

Add in-code docs for Rust #71

Closed xushiyan closed 1 month ago

KnightChess commented 3 months ago

does it meat add doc for every Moudles, Sturct, Method in code, like this?

/// Table interface for engine integrate
#[derive(Clone, Debug)]
pub struct Table {
    pub base_url: Arc<Url>,
    pub configs: Arc<HudiConfigs>,
    pub extra_options: Arc<HashMap<String, String>>,
    pub timeline: Timeline,
    pub file_system_view: FileSystemView,
}
xushiyan commented 3 months ago

@KnightChess that's correct. the goal is to make https://docs.rs/hudi/latest/hudi/ have docs

KnightChess commented 3 months ago

@xushiyan got it. I've been familiarizing myself with this project recently, and I can help contribute to this document.