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

refactor(interactive): Refine Interactive SDK documentation #3978

Merged
merged 31 commits into from
Jul 13, 2024

Conversation

zhanglei1949
Copy link
Collaborator

@zhanglei1949 zhanglei1949 commented Jun 26, 2024

The existing documentation lacks guides for users to initiate interactivity from the beginning, and the wrapper interfaces are not povided.

  • Add getting started (deploy, connect, create graph, bulk loading and submit query)
  • Add documentation for each wrapped sdk method.
  • Reuse the documentation for models.
  • Give a runnable example for each api.

@zhanglei1949 zhanglei1949 marked this pull request as draft June 26, 2024 12:17
Committed-by: xiaolei.zl from Dev container
Committed-by: xiaolei.zl from Dev container
Committed-by: xiaolei.zl from Dev container
Committed-by: xiaolei.zl from Dev container
Committed-by: xiaolei.zl from Dev container
Committed-by: xiaolei.zl from Dev container
Committed-by: xiaolei.zl from Dev container

Committed-by: xiaolei.zl from Dev container
Committed-by: xiaolei.zl from Dev container
@zhanglei1949 zhanglei1949 marked this pull request as ready for review July 4, 2024 06:43
Committed-by: xiaolei.zl from Dev container
Committed-by: xiaolei.zl from Dev container

Committed-by: xiaolei.zl from Dev container
@codecov-commenter
Copy link

Codecov Report

Attention: Patch coverage is 0% with 5 lines in your changes missing coverage. Please review.

Project coverage is 46.21%. Comparing base (36785af) to head (4cee66e).
Report is 24 commits behind head on main.

Additional details and impacted files

Impacted file tree graph

@@           Coverage Diff           @@
##             main    #3978   +/-   ##
=======================================
  Coverage   46.21%   46.21%           
=======================================
  Files         174      174           
  Lines       16176    16176           
=======================================
  Hits         7476     7476           
  Misses       8700     8700           
Files Coverage Δ
...on/graphscope/flex/rest/models/create_edge_type.py 0.00% <0.00%> (ø)
python/graphscope/flex/rest/models/edge_mapping.py 0.00% <0.00%> (ø)
...thon/graphscope/flex/rest/models/vertex_mapping.py 0.00% <0.00%> (ø)

... and 1 file with indirect coverage changes


Continue to review full report in Codecov by Sentry.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 7ab99ec...4cee66e. Read the comment docs.

Committed-by: xiaolei.zl from Dev container

Committed-by: xiaolei.zl from Dev container
Committed-by: xiaolei.zl from Dev container
Committed-by: xiaolei.zl from Dev container
Committed-by: xiaolei.zl from Dev container
longbinlai
longbinlai previously approved these changes Jul 11, 2024
Committed-by: xiaolei.zl from Dev container
lidongze0629
lidongze0629 previously approved these changes Jul 11, 2024
Committed-by: xiaolei.zl from Dev container
@zhanglei1949 zhanglei1949 merged commit feb026f into alibaba:main Jul 13, 2024
53 of 59 checks passed
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.

None yet

4 participants