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

[Doc]: The args of method annotations is inconsistent with the real args of the method #253

Closed
1 task done
haohao0103 opened this issue Oct 18, 2023 · 1 comment · Fixed by #267
Closed
1 task done
Assignees
Labels
Component:Documentation Improvements or additions to documentation

Comments

@haohao0103
Copy link
Contributor

Is there an existing issue for this?

  • I have searched the existing issues

Current Behavior

com.alibaba.graphar.util.FileSystem.scala
def writeDataFrame(...){}
image
The args of method annotations is inconsistent with the real args of the method,in the ide will give red

Expected Behavior

args in the annotation of the method are kept consistent with the true args

Minimal Reproducible Example

/**

  • Write input dataframe to output path with certain file format.
  • @param dataframe
  • DataFrame to write out.
  • @param fileType
  • output file format type, the value could be csv|parquet|orc.
  • @param outputPrefix
  • output path prefix.
  • @param startChunkIndex
  • the start index of chunk.
    */
    def writeDataFrame(
    dataFrame: DataFrame,
    fileType: String,
    outputPrefix: String,
    offsetStartChunkIndex: Option[Int],
    aggNumListOfEdgeChunk: Option[Array[Long]]
    ): Unit = {...

Environment

  • Operating system:mac
  • GraphAr version:main

Link to GraphAr Logs

No response

Further Information

No response

@lixueclaire
Copy link
Contributor

Hi, @haohao0103 . Thank you for bringing this issue to our attention. We would greatly appreciate your assistance in resolving it.

@haohao0103 haohao0103 changed the title [Bug]: <title>The args of method annotations is inconsistent with the real args of the method [Bug]: The args of method annotations is inconsistent with the real args of the method Oct 18, 2023
@acezen acezen changed the title [Bug]: The args of method annotations is inconsistent with the real args of the method [Doc]: The args of method annotations is inconsistent with the real args of the method Oct 25, 2023
@acezen acezen self-assigned this Oct 25, 2023
@acezen acezen added the Component:Documentation Improvements or additions to documentation label Oct 25, 2023
@acezen acezen added this to the Release v0.10.0 [In Progress] milestone Oct 27, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Component:Documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants