Skip to content

Conversation

@sherfert
Copy link
Contributor

No description provided.

Copy link
Collaborator

@renetapopova renetapopova left a comment

Choose a reason for hiding this comment

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

Thanks, @sherfert. I've added some suggestions in case it is still possible to change the messages in the code base.

= 22NBE

== Status description
error: data exception - invalid vector dimensions. Invalid vector dimensions. The number of vector dimensions needs to be between `{ <<count>> }` and `{ $count1 }`, but was `{ $count2 }`.
Copy link
Collaborator

Choose a reason for hiding this comment

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

Is it possible to change it in the codebase to:

Suggested change
error: data exception - invalid vector dimensions. Invalid vector dimensions. The number of vector dimensions needs to be between `{ <<count>> }` and `{ $count1 }`, but was `{ $count2 }`.
error: data exception - invalid vector dimensions. Invalid vector dimensions. The number of vector dimensions must be between `{ <<count>>1 }` and `{ $count2 }`, but is `{ $count3 }`.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Sure, I can change that.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

The arguments are called count, count1 and count2 though. Not count1, count2 and count3. That is in line with other numbered arguments we use.

Copy link
Collaborator

Choose a reason for hiding this comment

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

Could you give me an example? To me, count sounds like something in general, not a specific number, while count 1, 2, 3, etc. are specific numbers.

Copy link
Collaborator

Choose a reason for hiding this comment

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

At least, in the error messages, when the same variable is mentioned more than once in a message, we add 1, 2, 3, etc., to show that they have different values.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

At least, in the error messages, when the same variable is mentioned more than once in a message, we add 1, 2, 3, etc., to show that they have different values.

My bad, you're absolutely right. I'll fix that (here and in the monorepo, too).

= 22NBF

== Status description
error: data exception - property value too big. Property value of type `{ <<typeDescription>> }` too big (more than `{ <<bytes>> }` bytes): `{ <<value>> }`
Copy link
Collaborator

Choose a reason for hiding this comment

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

same here:

Suggested change
error: data exception - property value too big. Property value of type `{ <<typeDescription>> }` too big (more than `{ <<bytes>> }` bytes): `{ <<value>> }`
error: data exception - property value too big. Property value of type `{ <<typeDescription>> }` is too big (more than `{ <<bytes>> }` bytes): `{ <<value>> }`.

What would be the actual message that the users will receive? We try not to use the old formatting: message: what was wrong, but instead follow the guidelines: problem+cause+solution (if possible). That would mean the message would look something like this:

error: data exception - property value too big. The property value `{ <<value>> }` of type `{ <<typeDescription>> }` is too big (more than `{ <<bytes>> }` bytes).

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Adding "is" is no problem. I would rather not move { <<value>> }, though. It will without exception be very big (100 characters), since this error is only thrown for too big values. I think the error message is more readable if that big blob of data comes at the end, wdyt?

Copy link
Collaborator

Choose a reason for hiding this comment

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

Fair enough.

@neo4j-docops-agent
Copy link
Collaborator

neo4j-docops-agent commented Sep 10, 2025

Thanks for the documentation updates.

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

Copy link
Collaborator

@renetapopova renetapopova left a comment

Choose a reason for hiding this comment

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

Thank you, @sherfert. Looks good to me now.

@sherfert
Copy link
Contributor Author

Thank you, @sherfert. Looks good to me now.

Thanks!
Feel free to merge at your convenience. I am always unsure when and how it is allowed to merge in the docs repos 😆

@renetapopova renetapopova merged commit 230b1d5 into neo4j:dev Sep 10, 2025
4 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants