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.

Sign up for GitHub

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

Jump to bottom

doc(interactive): Add documentation for SDK implementation #4263

Closed
zhanglei1949 opened this issue Sep 25, 2024 · 1 comment · Fixed by #4268
Closed

doc(interactive): Add documentation for SDK implementation #4263

zhanglei1949 opened this issue Sep 25, 2024 · 1 comment · Fixed by #4268
Assignees
@zhanglei1949

Comments

@zhanglei1949
Copy link
Collaborator

zhanglei1949 commented Sep 25, 2024 •
edited
Loading

Currently Interactive SDK's Documentation has no introduction for the Implementation code such as Result.py.
@zhanglei1949 zhanglei1949 self-assigned this Sep 25, 2024
@longbinlai
Copy link
Collaborator

In addition, all returned data structure from response has not been introduced. For example,

resp = sess.create_graph(create_graph_request)
assert resp.is_ok()
return resp.get_value().graph_id

We do not know what resp.get_value() looks like, what data field can be accessed.

@zhanglei1949 zhanglei1949 mentioned this issue Sep 27, 2024
Merged
zhanglei1949 added a commit that referenced this issue Sep 29, 2024
@zhanglei1949
refactor(interactive): Refine the documentation of Interactive SDK (#…
1b4b809 
…4268)

The current Interactive SDK documentation only includes the Service APIs
and code generated by openapi-generator. This PR adds auto-generated
documentation for the hand-written wrapper and utility classes for SDKs.

Also add comments to python/java sdk code.

Fix #4263
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@zhanglei1949 zhanglei1949

Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

refactor(interactive): Refine the documentation of Interactive SDK zhanglei1949/GraphScope
2 participants
@longbinlai @zhanglei1949