Uploaded image for project: 'TinkerPop'
  1. TinkerPop
  2. TINKERPOP-2392

Improve module level documentation for GLVs

    XMLWordPrintableJSON

    Details

    • Type: Improvement
    • Status: Closed
    • Priority: Minor
    • Resolution: Done
    • Affects Version/s: 3.4.7
    • Fix Version/s: 3.5.0, 3.4.9
    • Component/s: documentation
    • Labels:
      None

      Description

      As an example of the general problem, the readme for the JavaScript client says:

      "Please see the reference documentation at Apache TinkerPop for more information."

      That reference documentation is completely written in Groovy and does not translate well to JavaScript. At the very least, there should be some documentation that describes how to translate all of the globals used across the reference documentation. For example, in http://tinkerpop.apache.org/docs/current/reference/#valuemap-step it is suggested that one can translate the list based values to singular values by writing:

      g.V().valueMap().by(unfold())
      

      How do I translate this for usage in the JavaScript client? I assume the `unfold()` method needs to be attached to the instance referenced by the `by()` function. How do I get that reference easily? Can I pass a parameter like `.by( () => this.unfold() )` (it certainly doesn't work)? Neither `.by("unfold()")` nor `.by("unfold")` work.

      This sort of thing is present throughout the reference documentation and is making it very difficult to get up-to-speed with the JavaScript client.

        Attachments

          Issue Links

            Activity

              People

              • Assignee:
                spmallette Stephen Mallette
                Reporter:
                jsumners James Sumners
              • Votes:
                0 Vote for this issue
                Watchers:
                3 Start watching this issue

                Dates

                • Created:
                  Updated:
                  Resolved: