[docs] Add write query example to README #157
Open
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Took me some diffing to figure out that `instance.cypher()` was an alias for `instance.readCypher()` and that there's also `instance.writeCypher()`. Furthermore, running a write query with `instance.cypher()` throws an error, so I felt it might be a good idea to add the existence of `instance.writeCypher()` to the README, and to clarify that `instance.cypher()` is for reading only. I hope this helps.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Took me some digging to figure out that
instance.cypher()was an alias forinstance.readCypher()and that there's alsoinstance.writeCypher().Furthermore, running a write query with
instance.cypher()throws an error, so I felt it might be a good idea to add the existence ofinstance.writeCypher()to the README, and to clarify thatinstance.cypher()is for reading only.I hope this helps.