feat: Method documentation

[rcollette]

I'm curious as to why there is no code documentation for any methods? It would make adoption a lot smoother.

I suspect there are Gremlinq specific caveats that could use explanation.

For example, in Coalesce expressions, if adding a Vertex as a SideEffect, can I still use AddV(somePOCO) or will I have to use more rudimentary commands (add the vertex, its label and its values separately)?

This coalesce parameter, is the last step in something like an upsert:

                q =>
                    q.SideEffect(q2 =>
                            q2.AddE<HasProperty>().To(v => v.AddV(propertyDefinition)))
                        .Out<HasProperty>()
                        .OfType<PropertyDefinition>()
                        .Where(pd => pd.Id == b.Of("propertyDefinitionId", propertyDefinition.Id))

Results in the error

ExRam.Gremlinq.Providers.Neptune.NeptuneGremlinQueryExecutionException: Expected an id that is convertible to String but received class java.util.LinkedHashMap

propertyDefinition.Id is a string.

I have no clue what is going on here. It would be nice if the expression "compiler" could catch this rather than it being a runtime issue.

[danielcweber]

I can be paid for anything you think is missing from this open source project with no sponsors.

[danielcweber]

@rcollette: Also, there is a support option: https://docs.gremlinq.net/support/

[rcollette]

You should probably turn off the discussion section if that's how responses come. OS efforts appreciated, but not sure there is a need to respond that way regarding questions or feedback.