-
Notifications
You must be signed in to change notification settings - Fork 12
Improve documentation of notification config #30
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Conversation
Looks like you've updated the documentation! Check out your changes at https://neo4j-docs-bolt-30.surge.sh |
Message and structure summaries are separated, but should at least link to each other as they are closely related.
One aspect that has been missed from the notifications config description is that by disabling a categories or severities means the server doesn't carry out analysis for those. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
👙
@thelonelyvulpes That's an interesting point I didn't consider. But I'd argue that these docs are more about the syntax of the protocol and only the semantics inherent to the protocol but not the those semantics defined by the DBMS. Just like we don't describe what Cypher is or how it works here. On that note tho, this info should be documented somewhere! I'm just not sure where the best place would be? The driver docs? The cypher docs? |
I agree i think this doc is not the place but should be somewhere! |
I think driver docs is the best place -- or at least, it should be there, and optionally somewhere else as well. I am planning to add a section about notifications in the new manuals, so this will also go in. At the same time, I think there's no harm in dropping a sentence here in Bolt, somewhere. It is informative, and as long as it doesn't digress too much (but again, once sentence, as Grant wrote), it doesn't distract from the rest of docs. |
@stefano-ottolenghi added a sentence (in 3 places though). What do you think? |
@robsdedude comma between |
caused by structure and message changes being listed separately.