Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add in-code docs for Rust #71

Closed
xushiyan opened this issue Jul 18, 2024 · 3 comments · Fixed by #166
Closed

Add in-code docs for Rust #71

xushiyan opened this issue Jul 18, 2024 · 3 comments · Fixed by #166
Assignees
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers rust Related to Rust codebase
Milestone

Comments

@xushiyan
Copy link
Member

No description provided.

@xushiyan xushiyan added documentation Improvements or additions to documentation good first issue Good for newcomers rust Related to Rust codebase labels Jul 18, 2024
@xushiyan xushiyan added this to the release-0.2.0 milestone Jul 18, 2024
@KnightChess
Copy link
Contributor

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
Copy link
Member Author

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

@KnightChess
Copy link
Contributor

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers rust Related to Rust codebase
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants