use quote in backticks rather than escape #1111
Merged
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
l-heemann
approved these changes
Nov 14, 2024
Contributor
l-heemann
left a comment
l-heemann
left a comment
There was a problem hiding this comment.
Looks good, I have a couple of suggestions but nothing major. Thanks for the quick turnaround!
modules/ROOT/pages/styleguide.adoc
Outdated
| ---- | ||
|
|
||
| * Avoid having to use back-ticks to escape characters and keywords. | ||
| * Avoid having to use backticks to quote characters and keywords. |
Contributor
There was a problem hiding this comment.
Suggested change
| * Avoid having to use backticks to quote characters and keywords. | |
| * Avoid using characters and keywords that require the input to be quoted. |
Feels a little bit more actionable than "avoid having the db force a rule on you"
| * Parameters | ||
|
|
||
| If any reserved keyword is escaped -- i.e. is encapsulated by backticks ```, such as `++`AND`++` -- it would become a valid identifier in the above contexts. | ||
| If any reserved keyword is quoted in backticks (```), such as `++`AND`++`, it would become a valid identifier in the above contexts. |
Contributor
There was a problem hiding this comment.
Maybe we should add that this isn't recommended, or maybe that is obvious 🤔
Collaborator
|
Thanks for the documentation updates. The preview documentation has now been torn down - reopening this PR will republish it. |
renetapopova
added a commit
to neo4j/docs-operations
that referenced
this pull request
Nov 14, 2024
This is the only mention of escaping with backticks that I found in the Operations manual. Cypher Manual PR: neo4j/docs-cypher#1111
renetapopova
added a commit
to renetapopova/docs-operations
that referenced
this pull request
Nov 14, 2024
This is the only mention of escaping with backticks that I found in the Operations manual. Cypher Manual PR: neo4j/docs-cypher#1111
JPryce-Aklundh
added a commit
that referenced
this pull request
Nov 14, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
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.
Ops Manual PR: neo4j/docs-operations#1959