Skip to content

Conversation

@rsill-neo4j
Copy link
Collaborator

part 1 - more commits will follow

@changeset-bot
Copy link

changeset-bot bot commented Dec 11, 2025

⚠️ No Changeset found

Latest commit: 922d188

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

Copy link
Member

@angrykoala angrykoala left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Good job, just a few small changes


To make a `CREATE` clause, first create a valid pattern using the xref:/patterns.adoc[Pattern] class:

To add the clause, first create a valid pattern using the xref:/patterns.adoc[Pattern] class:
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This page relates to CREATE clause, but I feel it may still be confusing to just refer to it as "the clause". In many places we need to either use multiple clauses or we may reference other clauses, so even at the risk of it being a bit verbose, I'd prefer for the create to be explicitly referenced

Comment on lines 67 to 66
`.set` take tuples of 2 elements, the first being the property to update and the second the value:
`.set` takes a tuple of two elements - a property to update and a new value:
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This may be hard to explain, but the method take multiple tuples, so the proposed change is not accurate

So, for example:

.set(
[movie.property("title"), new Cypher.Param("The Matrix")], // Tuple 1
[movie.property("description"), new Cypher.Param("A description")] //Tuple 2
)

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

rephrased

This page describes how to create a link:https://neo4j.com/docs/cypher-manual/current/clauses/match/[`MATCH`] clause with the `Cypher.Match` class.

To create a `MATCH` clause, first create a valid pattern using the xref:/patterns.adoc[Pattern] class and pass it to `Match` constructor:
To add the clause, first create a valid pattern using the xref:/patterns.adoc[Pattern] class and pass it to the `Match` constructor:
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Same as with CREATE I'd rather specify the clause explicitly

Comment on lines 46 to 47
`ON CREATE SET` and `ON MATCH SET` can follow a `MERGE` statement.
You can achieve this with the methods `onCreateSet` and `onMatchSet` respectively:
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Following the pattern in the other changes, isn't more consistent something a bit more like:

use the methods `onCreateSet` .... to add the clauses `ON CREATE SET`...

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

rephrased

@sonarqubecloud
Copy link

@neo4j-docops-agent
Copy link

neo4j-docops-agent commented Dec 16, 2025

Thanks for the documentation updates.

The preview documentation has now been torn down - reopening this PR will republish it.

@angrykoala angrykoala merged commit c392ca4 into main Dec 17, 2025
18 checks passed
@angrykoala angrykoala deleted the editorial-review branch December 17, 2025 15:50
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants