Copilot commented on code in PR #444:
URL: 
https://github.com/apache/incubator-hugegraph-doc/pull/444#discussion_r2711183597


##########
content/cn/docs/clients/restful-api/graphs.md:
##########
@@ -166,11 +166,21 @@ POST 
http://localhost:8080/graphspaces/DEFAULT/graphs/hugegraph-xx
 
 ##### Request Body
 
-创建一个非鉴权模式的图(设置 `Content-Type: application/json`)
+创建一个图(设置 `Content-Type: application/json`)
+
+**`gremlin.graph` 配置说明:**
+- 鉴权模式:`"gremlin.graph": "org.apache.hugegraph.auth.HugeFactoryAuthProxy"`(推荐)
+- 非鉴权模式:`"gremlin.graph": "org.apache.hugegraph.HugeFactory"`
+
+**注意**!!
+1. 在 1.7.0 版本中,动态创建图会导致 NPE 错误。该问题已在 
[PR#2912](https://github.com/apache/incubator-hugegraph/pull/2912) 中修复。当前 
master 版本和 1.7.0 之前的版本不受此问题影响。

Review Comment:
   The version reference "1.7.0 之前" (before 1.7.0) is inconsistent with line 
177 which states "1.7.0 及之前版本" (version 1.7.0 and earlier). The sentence says 
that master and versions before 1.7.0 don't have the problem, which contradicts 
the next sentence that says 1.7.0 and earlier versions require specific 
configuration. The version ranges in these two consecutive statements are 
inconsistent and confusing.
   ```suggestion
   1. 在 1.7.0 版本中,动态创建图会导致 NPE 错误,仅影响该版本。该问题已在 
[PR#2912](https://github.com/apache/incubator-hugegraph/pull/2912) 中修复。
   ```



##########
content/en/docs/clients/restful-api/graphs.md:
##########
@@ -166,11 +166,21 @@ POST 
http://localhost:8080/graphspaces/DEFAULT/graphs/hugegraph2
 
 ##### Request Body
 
-Create a non-auth graph (set `Content-Type: application/json`)
+Create a graph (set `Content-Type: application/json`)
+
+**`gremlin.graph` Configuration:**
+- Auth mode: `"gremlin.graph": 
"org.apache.hugegraph.auth.HugeFactoryAuthProxy"` (Recommended)
+- Non-auth mode: `"gremlin.graph": "org.apache.hugegraph.HugeFactory"`
+
+**Note**!!
+1. In version 1.7.0, dynamic graph creation would cause a NPE. This issue has 
been fixed in 
[PR#2912](https://github.com/apache/incubator-hugegraph/pull/2912). The current 
master version and version 1.7.0- do not have this problem.

Review Comment:
   The version reference "1.7.0-" appears to be a typo or unclear notation. It 
should likely be "1.7.0 and earlier" or "versions before 1.7.0" for clarity. 
The hyphen after "1.7.0" is confusing.
   ```suggestion
   1. In version 1.7.0, dynamic graph creation would cause a NPE. This issue 
has been fixed in 
[PR#2912](https://github.com/apache/incubator-hugegraph/pull/2912). The current 
master version and versions after 1.7.0 do not have this problem.
   ```



##########
content/en/docs/quickstart/hugegraph/hugegraph-server.md:
##########
@@ -216,10 +216,27 @@ task.scheduler_type=distributed
 pd.peers=127.0.0.1:8686,127.0.0.1:8687,127.0.0.1:8688
 ```
 
+```properties
+# Simple example (with authentication)
+gremlin.graph=org.apache.hugegraph.auth.HugeFactoryAuthProxy
+
+# Specify storage backend hstore
+backend=hstore
+serializer=binary
+store=hugegraph
+task.scheduler_type=distributed
+
+# pd config
+pd.peers=127.0.0.1:8686
+```

Review Comment:
   The comment says "task.scheduler_type=distributed" is required, but this 
line is missing from the configuration block. According to the description and 
other parts of the documentation, this configuration should be included in the 
example.



##########
content/en/docs/clients/restful-api/graphs.md:
##########
@@ -166,11 +166,21 @@ POST 
http://localhost:8080/graphspaces/DEFAULT/graphs/hugegraph2
 
 ##### Request Body
 
-Create a non-auth graph (set `Content-Type: application/json`)
+Create a graph (set `Content-Type: application/json`)
+
+**`gremlin.graph` Configuration:**
+- Auth mode: `"gremlin.graph": 
"org.apache.hugegraph.auth.HugeFactoryAuthProxy"` (Recommended)
+- Non-auth mode: `"gremlin.graph": "org.apache.hugegraph.HugeFactory"`
+
+**Note**!!
+1. In version 1.7.0, dynamic graph creation would cause a NPE. This issue has 
been fixed in 
[PR#2912](https://github.com/apache/incubator-hugegraph/pull/2912). The current 
master version and version 1.7.0- do not have this problem.

Review Comment:
   The version reference "1.7.0-" followed by the statement "For version 1.7.0 
and earlier" in line 177 creates inconsistent and confusing version ranges. The 
first sentence suggests that master and "1.7.0-" (unclear notation) don't have 
the NPE problem, but the second sentence says "version 1.7.0 and earlier" 
requires specific configuration. These two statements appear contradictory 
regarding whether version 1.7.0 has the problem or not.
   ```suggestion
   1. In version 1.7.0, dynamic graph creation could cause an NPE. This issue 
was fixed in 
[PR#2912](https://github.com/apache/incubator-hugegraph/pull/2912), and the 
current master branch and all versions after 1.7.0 do not have this problem.
   ```



-- 
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]

Reply via email to