imbajin commented on code in PR #150:
URL:
https://github.com/apache/incubator-hugegraph-ai/pull/150#discussion_r1900596249
##########
hugegraph-python-client/README.md:
##########
@@ -20,21 +25,19 @@ pip install .
pip install -e .
```
-## Examples
+## Usage
+
+### Defining Graph Structures
+
+You can use the `hugegraph-python-client` to define graph structures. Below is
an example of how to define a graph:
```python
from pyhugegraph.client import PyHugeClient
-# For HugeGraph API version ≥ v3: (Or enable graphspace function)
-# - The 'graphspace' parameter becomes relevant if graphspaces are
enabled.(default name is 'DEFAULT')
-# - Otherwise, the graphspace parameter is optional and can be ignored.
+# Initialize the client
client = PyHugeClient("127.0.0.1", "8080", user="admin", pwd="admin",
graph="hugegraph", graphspace="DEFAULT")
-""""
-Note:
-Could refer to the official REST-API doc of your HugeGraph version for
accurate details.
-If some API is not as expected, please submit a issue or contact us.
-"""
Review Comment:
seems we should keep the original comment for users to understand
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: [email protected]
For queries about this service, please contact Infrastructure at:
[email protected]
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]