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][Spark] Update the doc: fix the outdated argument annotations and typo #267

Merged
merged 4 commits into from
Oct 30, 2023

Conversation

acezen
Copy link
Contributor

@acezen acezen commented Oct 27, 2023

Proposed changes

as title.

Types of changes

What types of changes does your code introduce to GraphAr?
Put an x in the boxes that apply

  • Bugfix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • Documentation Update (if none of the other choices apply)

Checklist

Put an x in the boxes that apply. You can also fill these out after creating the PR. If you're unsure about any of them, don't hesitate to ask. We're here to help! This is simply a reminder of what we are going to look for before merging your code.

  • I have read the CONTRIBUTING doc
  • I have signed the CLA
  • Lint and unit tests pass locally with my changes
  • I have added tests that prove my fix is effective or that my feature works
  • I have added necessary documentation (if appropriate)

Further comments

close #253

Signed-off-by: acezen <qiaozi.zwb@alibaba-inc.com>
@acezen acezen changed the title [Doc][Spark] Update the doc: fix the outdated parameter comment and typo [Doc][Spark] Update the doc: fix the outdated argument annotations and typo Oct 27, 2023
Signed-off-by: acezen <qiaozi.zwb@alibaba-inc.com>
*
* @param dataframe
* @param dataFrame
Copy link
Contributor

Choose a reason for hiding this comment

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

DataFrame

Copy link
Contributor Author

Choose a reason for hiding this comment

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

the parameter name is dataFrame

@acezen acezen merged commit b50ae72 into apache:main Oct 30, 2023
3 checks passed
@acezen acezen deleted the 253-spark-doc-outdated branch October 30, 2023 02:54
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[Doc]: The args of method annotations is inconsistent with the real args of the method
2 participants