GumpacG opened a new pull request, #3534:
URL: https://github.com/apache/tinkerpop/pull/3534
## Summary
The reference documentation under `docs/src/reference/` described driver
configuration options, default values, class names, and code examples that no
longer matched the source. This PR corrects those inaccuracies across all
five
drivers (JVM, Python, .NET, Go, JavaScript), fixes three stale javadoc
comments
in `gremlin-driver` that were the origin of some doc errors, and adds a
`CHANGELOG` entry. All changes are documentation or comment only; no runtime
behavior changes.
## What changed and why
### JavaScript
- Removed `pingEnabled` / `pingInterval` / `pongTimeout`: the driver's
ping/pong
logic was removed in `4e99e77f6a` (#2506, Mar 2024) but the rows were
never deleted.
- `mimeType` default -> `application/vnd.graphbinary-v1.0`: 3.8 switched the
default serializer to GraphBinary while the docs kept the old GraphSON
v3.0 value.
- `writer` type -> `GraphSONWriter/GraphBinaryWriter`: the row omitted the
GraphBinary writer that `#getDefaultWriter` returns for the now-default
mime type.
- Added `materializeProperties`: it is accepted in the driver's per-request
`allowedKeys` but was missing from the documented list.
### Python
- `pool_size` 4 -> 8: the implementation default is 8 (`client.py`); the doc
value was stale.
- `max_workers`: the doc claimed "CPUs * 5" but the code defaults it to
`pool_size`.
- `enable_compression` description: copy-pasted verbatim from the neighboring
`enable_user_agent_on_connect` row when both were added in `ca5414fcb7`
(Oct 2024).
- Added `materializeProperties`: accepted by `_extract_request_options` but
omitted from the list.
### .NET
- `PoolSize` 4 -> 8: implementation default is 8 (`ConnectionPoolSettings`);
doc value stale.
- `MaxInProcessPerConnection` 32 -> 16: implementation default is 16; doc
value stale.
- `ConnectionPoolBusyException`: the docs named the base class, but the code
throws this more specific subclass.
### Go
- `/v3` import path: the module moved to a v3 major version, so the import
path requires `/v3`.
- `ConnectionTimeout` 45s -> 5s: implementation default is 5s
(`gorillaTransporter.go`); doc value stale.
- `ReadBufferSize` / `WriteBufferSize` 0 -> 1048576: the driver initializes
these to 1 MB; the doc showed 0.
- `gremlingo.INFO` -> `Info`: the constant is named `Info`; `INFO` never
existed.
- `Session`: the field is unexported and not settable via the config
function, contrary to what the table implied.
### JVM driver
- `port` 8192 -> 8182: the doc copied the stale `Settings.java` javadoc; the
field value is 8182.
- `maxWaitForConnection` 3000 -> 16000: the doc copied a stale javadoc; the
constant is 16000.
- `maxContentLength` 65536 -> 10485760: the doc copied a stale javadoc; the
constant is 10 MB.
- `minSimultaneousUsagePerConnection` description: it was copy-pasted from
the max-variant row.
### Server / Console
- GraphSON serializer class names: the docs used pre-3.3/3.5 `Gremlin` /
`d0` names for classes that were later renamed.
- Server `maxContentLength` 65536 -> 10485760: the server default is 10 MB;
the doc value was stale.
- `plugin activated:`: the console prints "activated", not "loaded", so the
example output was wrong.
### Examples and references
- `traversal().with(...)`: the example omitted the parentheses on the static
factory and would not compile.
- `Neo4jGraph.open()`: there is no class named `Neo4j`; the factory lives on
`Neo4jGraph`.
- `getVertexComputeKeys()`: `getElementComputeKeys()` is a pre-3.2 name that
was renamed.
- `createIndex` receiver: `createIndex` is on `TinkerGraph`, not the core
`Graph` interface, so the example would not compile.
- `maxDistance(Number)`: the builder method takes a `Number`, not a
`Traversal`.
- dateDiff link + deprecation: the `OffsetDateTime` link pointed at the
`Date` anchor, and `dateDiff(Date)` is deprecated as of 3.8.0.
### Code comments
- `Settings.java` javadocs (`port`, `maxWaitForConnection`,
`maxContentLength`):
the comments stated defaults that no longer matched the field/constant
values
and were the source of the doc-table errors.
## Verification
Every corrected value was cross-checked against the source at all layers that
determine the effective default a user receives: the constant, the settings
object, and the builder for the JVM driver; and both the direct client and
the
remote-connection wrapper for each language variant. This confirmed the
documented value matches actual behavior and is not contradicted by another
file.
Assisted-by: Kiro: Claude Opus 4.8
--
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]
