Adding notes about syntax to explain the use of quotation marks #252
Conversation
lidiazuin
added
bug
|
Looks like you've updated the documentation! Check out your changes at https://neo4j-docs-cypher-252.surge.sh |
|
The difficulty is you need some mechanism to differentiate between the character { in they cypher syntax and the character { in the formal definition of they syntax. I don't think quote marks are incorrect here, although there may be better ways to express it. Removing them seems wrong to me. e.g. Does ()-[r:TYPE_NAME]-() mean that r:TYPE_NAME is optional, or does it mean that it should be in square brackets? |
|
To add on to Marks comment: (In #225 I've added a note and link to that section to make it easier to find, those notes might be nice to backport even if nothing else from the PR should be backported) |
|
|
||
| [NOTE] | ||
| ==== | ||
| The syntax descriptions use xref:access-control/index.adoc#access-control-syntax[the style] from access control. |
There was a problem hiding this comment.
This comment should also be added in:
- https://neo4j.com/docs/cypher-manual/current/indexes-for-full-text-search/#administration-indexes-fulltext-search-create-and-configure
- https://neo4j.com/docs/cypher-manual/current/constraints/syntax/
- https://neo4j.com/docs/cypher-manual/current/clauses/listing-functions/#_syntax
- https://neo4j.com/docs/cypher-manual/current/clauses/listing-procedures/#_syntax
- https://neo4j.com/docs/cypher-manual/current/clauses/transaction-clauses/#_syntax
- https://neo4j.com/docs/cypher-manual/current/clauses/transaction-clauses/#_syntax_2
- https://neo4j.com/docs/cypher-manual/current/databases/
- https://neo4j.com/docs/cypher-manual/current/aliases/
Since the syntax summary descriptions lives in the access control chapters intro I don't think it needs to be added to all the sections in that part, but otherwise it could be added to these as well:
- https://neo4j.com/docs/cypher-manual/current/access-control/manage-users/#access-control-user-syntax
- https://neo4j.com/docs/cypher-manual/current/access-control/manage-roles/#access-control-role-syntax
- https://neo4j.com/docs/cypher-manual/current/access-control/manage-privileges/
- https://neo4j.com/docs/cypher-manual/current/access-control/manage-servers/ (might be good to add it here if you move this section out as we talked about Jens)
- https://neo4j.com/docs/cypher-manual/current/access-control/privileges-reads/
- https://neo4j.com/docs/cypher-manual/current/access-control/privileges-writes/
- https://neo4j.com/docs/cypher-manual/current/access-control/database-administration/
- https://neo4j.com/docs/cypher-manual/current/access-control/dbms-administration/#access-control-dbms-administration-role-management
- https://neo4j.com/docs/cypher-manual/current/access-control/dbms-administration/#access-control-dbms-administration-user-management
- https://neo4j.com/docs/cypher-manual/current/access-control/dbms-administration/#access-control-dbms-administration-impersonation
- https://neo4j.com/docs/cypher-manual/current/access-control/dbms-administration/#access-control-dbms-administration-database-management
- https://neo4j.com/docs/cypher-manual/current/access-control/dbms-administration/#access-control-dbms-administration-alias-management
- https://neo4j.com/docs/cypher-manual/current/access-control/dbms-administration/#access-control-dbms-administration-server-management
- https://neo4j.com/docs/cypher-manual/current/access-control/dbms-administration/#access-control-dbms-administration-privilege-management
- https://neo4j.com/docs/cypher-manual/current/access-control/dbms-administration/#access-control-dbms-administration-execute
- https://neo4j.com/docs/cypher-manual/current/access-control/dbms-administration/#access-control-dbms-administration-all
|
|
||
| [NOTE] | ||
| ==== | ||
| The syntax descriptions use xref:access-control/index.adoc#access-control-syntax[the style] from access control. |
There was a problem hiding this comment.
I'd put this higher up, between the Syntax header and the Syntax for creating constraints header as it applies to the full syntax chapter and not just the creates part
modules/ROOT/pages/databases.adoc
Outdated
|
|
||
| [NOTE] | ||
| ==== | ||
| The syntax descriptions use xref:access-control/index.adoc#access-control-syntax[the style] from access control. |
There was a problem hiding this comment.
I think you added it above the syntax descriptions in all other places?
There was a problem hiding this comment.
Yes, because there was this sentence "The syntax of the database management commands is as follows:" and I thought putting the note right after that would look weird, but I'll change that so we can decide which way is better!
modules/ROOT/pages/aliases.adoc
Outdated
|
|
||
| [NOTE] | ||
| ==== | ||
| The syntax descriptions use xref:access-control/index.adoc#access-control-syntax[the style] from access control. |
There was a problem hiding this comment.
I think you added it above the syntax descriptions in all other places?
Hunterness
left a comment
Hunterness
left a comment
There was a problem hiding this comment.
I think it looks okej like this at least :D
lidiazuin
changed the title
5 participants
No description provided.