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

[Improve][Doc] Revise the README and APIs docstring of GraphAr #64

Merged
merged 9 commits into from
Jan 9, 2023

Conversation

acezen
Copy link
Contributor

@acezen acezen commented Jan 6, 2023

Proposed changes

This change revise the README and APIs docstring of GraphAr including:

  • revise api reference
  • clear document organization
  • unify the API docstring style

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

#19 #20

@acezen acezen added Component:Documentation Improvements or additions to documentation improvement Improvement labels Jan 6, 2023
Update

Update

Update

Update

Update

Update

Update api

Update

Update

Update the APIs

Update

Update

Update

Unify api document style

Update

Update

Minor fix

Format

Minor fix

Minor fix

Update

Update

Update

Minor fix

Minor fix

Update

Update
@acezen acezen requested review from lixueclaire and yecol January 9, 2023 01:52
include/gar/utils/yaml.h Outdated Show resolved Hide resolved
docs/user-guide/spark-tool.rst Show resolved Hide resolved
include/gar/graph_info.h Outdated Show resolved Hide resolved
include/gar/graph_info.h Outdated Show resolved Hide resolved
include/gar/graph_info.h Outdated Show resolved Hide resolved
README.rst Outdated Show resolved Hide resolved
README.rst Outdated Show resolved Hide resolved
README.rst Show resolved Hide resolved
README.rst Outdated Show resolved Hide resolved
README.rst Outdated Show resolved Hide resolved
Copy link
Contributor

@lixueclaire lixueclaire left a comment

Choose a reason for hiding this comment

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

LGTM.

@acezen acezen merged commit e8edfe3 into apache:main Jan 9, 2023
@acezen acezen deleted the 19-refine-readme branch January 9, 2023 07:52
@github-actions
Copy link

github-actions bot commented Jan 9, 2023

🎊 PR Preview e8edfe3 has been successfully built and deployed to https://alibaba-GraphAr-build-pr-64.surge.sh

🕐 Build time: 0.014s

🤖 By surge-preview

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 improvement Improvement
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants