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

docs(core): add the description of version parameter for operator #5144

Merged
merged 2 commits into from
Nov 26, 2024

Conversation

meteorgan
Copy link
Contributor

Which issue does this PR close?

Part of #2611.

Rationale for this change

What changes are included in this PR?

Are there any user-facing changes?

@meteorgan meteorgan marked this pull request as ready for review September 25, 2024 15:42
@meteorgan meteorgan requested a review from Xuanwo as a code owner September 25, 2024 15:42
@meteorgan
Copy link
Contributor Author

why is there no # before use opendal::Operator; at line 127 ? is a mistake or intentional ? do we have any guidelines for this ?

/// # Examples
///
/// ```
/// # use std::sync::Arc;
/// # use anyhow::Result;
/// use opendal::Operator;
///
/// # async fn test(op: Operator) -> Result<()> {
/// let info = op.info();
/// # Ok(())
/// # }
/// ```

@Xuanwo
Copy link
Member

Xuanwo commented Sep 27, 2024

why is there no # before use opendal::Operator; at line 127 ? is a mistake or intentional ? do we have any guidelines for this ?

/// # Examples
///
/// ```
/// # use std::sync::Arc;
/// # use anyhow::Result;
/// use opendal::Operator;
///
/// # async fn test(op: Operator) -> Result<()> {
/// let info = op.info();
/// # Ok(())
/// # }
/// ```

I believe it's intentional. We don't have guidelines for this. Please feel free to write in your preferred way.

core/src/types/operator/operator.rs Outdated Show resolved Hide resolved
core/src/types/operator/operator.rs Outdated Show resolved Hide resolved
core/src/types/operator/operator.rs Outdated Show resolved Hide resolved
core/src/types/operator/operator.rs Outdated Show resolved Hide resolved
core/src/types/operator/operator.rs Outdated Show resolved Hide resolved
core/src/types/operator/operator.rs Outdated Show resolved Hide resolved
core/src/types/operator/operator.rs Outdated Show resolved Hide resolved
core/src/types/operator/operator.rs Outdated Show resolved Hide resolved
core/src/types/operator/operator.rs Outdated Show resolved Hide resolved
Copy link
Member

@Xuanwo Xuanwo left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you @meteorgan for this!

@Xuanwo Xuanwo merged commit 5834e28 into apache:main Nov 26, 2024
239 checks passed
@meteorgan meteorgan deleted the versioning-docs branch December 3, 2024 04:59
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants