Skip to content

Conversation

@JoelBergstrand
Copy link
Contributor

Notification from OPTIONAL CALL PR.

@JoelBergstrand JoelBergstrand added the 5.x LTS version label Sep 4, 2024
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, @JoelBergstrand. It looks good. I added a small suggestion and a comment.

=====

[#_neo_clientnotification_statement_superfluousoptional]
=== Superfluous Optional
Copy link
Collaborator

Choose a reason for hiding this comment

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

Suggested change
=== Superfluous Optional
=== Superfluous optional

|Neo4j code
m|Neo.ClientNotification.Statement.SuperfluousOptional
|Title
a|The use of OPTIONAL is superfluous when `CALL` is a unit subquery or a void procedure.
Copy link
Collaborator

Choose a reason for hiding this comment

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

Suggested change
a|The use of OPTIONAL is superfluous when `CALL` is a unit subquery or a void procedure.
a|The use of `OPTIONAL` is superfluous when `CALL` is a unit subquery or a void procedure.

Copy link
Collaborator

Choose a reason for hiding this comment

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

This should also be changed in the code if we change it here.

|Title
a|The use of OPTIONAL is superfluous when `CALL` is a unit subquery or a void procedure.
|Description
|The use of OPTIONAL is superfluous when `CALL` is a unit subquery or a void procedure.
Copy link
Collaborator

Choose a reason for hiding this comment

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

Suggested change
|The use of OPTIONAL is superfluous when `CALL` is a unit subquery or a void procedure.
|The use of `OPTIONAL` is superfluous when `CALL` is a unit subquery or a void procedure.

|GQLSTATUS code
m|03N61
|Status description
a|info: superfluous optional. The use of optional is superfluous when `CALL` is a unit subquery or a void procedure.
Copy link
Collaborator

Choose a reason for hiding this comment

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

Suggested change
a|info: superfluous optional. The use of optional is superfluous when `CALL` is a unit subquery or a void procedure.
a|info: superfluous optional. The use of `OPTIONAL` is superfluous when `CALL` is a unit subquery or a void procedure.

@renetapopova renetapopova added 5.24 and removed 5.x LTS version labels Sep 4, 2024
@JoelBergstrand
Copy link
Contributor Author

Thanks @renetapopova for the comments. We decided to split the notification in two, I've added examples two both of them and capitalized. Would appreciate you comments on the wording of the notifications and descriptions.

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.

Hey @JoelBergstrand, I added some editorial suggestions, mainly regarding consistency with the rest of the page and the monorepo. The docs should reflect the code because we'll be adding tests at some point to make sure all notifications and their details are up-to-date. So, any discrepancies between the docs and the neo4j repository will lead to failures.

.Redundant use of optional on a procedure call.
[.tabbed-example]
=====
[.include-with-neo4j-code]
Copy link
Collaborator

Choose a reason for hiding this comment

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

You must also add a tab example for the GQLSTATUS code, similar to the rest of the notifications.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I think I've misunderstood the format. I'm pushing some changes to align with the rest of the notifications. I'll make sure that the notifications in the monorepo correspond to what is written here, in substance and formatting.

|===

.Redundant use of optional on a call subquery.
[.tabbed-example]
Copy link
Collaborator

Choose a reason for hiding this comment

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

This one also needs a tab example for the GQLSTATUS code, similar to the rest of the notifications.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I think I've misunderstood the format. I'm pushing some changes to align with the rest of the notifications. I'll make sure that the notifications in the monorepo correspond to what is written here, in substance and formatting.

@neo-technology-commit-status-publisher
Copy link
Collaborator

neo-technology-commit-status-publisher commented Sep 9, 2024

Thanks for the documentation updates.

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

@JoelBergstrand
Copy link
Contributor Author

Good morning @renetapopova! Do you have any additional comments on this addition to the docs?

@renetapopova renetapopova self-requested a review September 17, 2024 14:27
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.

Looks good. Thanks, @JoelBergstrand!

@JoelBergstrand JoelBergstrand merged commit f1d09ca into neo4j:dev Sep 17, 2024
NataliaIvakina pushed a commit to NataliaIvakina/docs-status-codes that referenced this pull request Sep 26, 2024
Notification from [OPTIONAL CALL
PR](neo-technology/neo4j#26755).

---------

Co-authored-by: Reneta Popova <[email protected]>
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.

3 participants