spmallette opened a new pull request, #3628:
URL: https://github.com/apache/tinkerpop/pull/3628

   The Java listing in the Program Step section of the reference docs 
(`reference/the-traversal.asciidoc#program-step`) had two problems that could 
block a reader trying to use it as a starting point.
   
   **Unbalanced braces.** The listing was missing the closing brace for 
`execute()`, so the block had eight opening braces and only seven closing ones. 
As written, `terminate()` read as if it were nested inside `execute()`. This 
restores the missing brace so the listing is balanced.
   
   **Presented as a complete class, but it is not.** The listing shows only 
selected methods and omits the class declaration, field and import definitions, 
and several of the `VertexProgram` interface methods, so it does not compile on 
its own. Rather than expand it into a full class, this labels it honestly as 
key-method excerpts: a short lead-in explains that the fragments are 
illustrative, a block title marks the listing as excerpts, and readers are 
pointed to a complete, runnable implementation to model against — the 
`TestProgram` vertex program in `gremlin-test` 
(`gremlin-test/src/main/java/org/apache/tinkerpop/gremlin/process/traversal/step/map/ProgramTest.java`).
   
   The existing `PageRankVertexProgram` example that shows how a vertex program 
is passed to `program()` is left unchanged. No other section or file is touched.


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

Reply via email to