-
Notifications
You must be signed in to change notification settings - Fork 34
Add examples to the glossary descriptions #275
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
This PR includes documentation updates Updated pages: |
Hey @Lojjs, I've also created 3 cards folowing our discussions on Thursday. I wonder if we want to doble-check with one more person, for example, Lasse, if the parameters' descriptions make sense to him as well. |
a1d5526
to
80290c8
Compare
…ifictaions, and fix inconsistencies in variables and descriptions
80290c8
to
9ba8c61
Compare
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.
Just some smaller things. Feel free to ask Lasse or Natalia for a review too if you want another pair of eyes on it as I have cowritten it
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.
Good improvement 🚀
Co-authored-by: Lasse Heemann <7661319+l-heemann@users.noreply.github.com>
Co-authored-by: Lasse Heemann <7661319+l-heemann@users.noreply.github.com>
Co-authored-by: Lasse Heemann <7661319+l-heemann@users.noreply.github.com>
Co-authored-by: Lasse Heemann <7661319+l-heemann@users.noreply.github.com>
Co-authored-by: Lasse Heemann <7661319+l-heemann@users.noreply.github.com>
Co-authored-by: Lasse Heemann <7661319+l-heemann@users.noreply.github.com>
Thanks for the documentation updates. The preview documentation has now been torn down - reopening this PR will republish it. |
//52N22 and 52N36 to change $field to $arg. Check 22N98 with Antonio. | ||
[[fun]]$fun:: Function name, for example, `collect()`. | ||
[[funClass]]$funClass:: User-defined function implementation class name, for example, `MyFunctionClass`. | ||
[[graph]]$graph:: The name of a graph, for example, `myGraph`. |
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.
Out of curiosity, is this parameter for GDS-related features?
How do we (in the team-errors) define and distinguish graph and database?
We have these terms in the Neo4j Glossary. Are those definitions still true and valid?
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.
I believe graph
here is unrelated to the graph
in GDS, both referencing the scientific concept that Neo4j builds on https://en.wikipedia.org/wiki/Graph_theory.
@nadja-muller Do you have a more detailed explanation for the graph
vs database
question? I attempted an example with composite but that felt more confusing than helpful 😅
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.
It's a bit tricky. I think what we ended up on was:
- graph: logical object, data in the database container e.g. once you access the data, you try to access the graph (which is why it is used as a target of the USE clause)
- database: container/file of the graph (which is why it is used in the administration commands)
I'm not sure how to write this out formally, however. There are very close to each other. Does that help you?
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.
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.
@l-heemann, are you happy with this PR? May I merge it?
Co-authored-by: Lasse Heemann <7661319+l-heemann@users.noreply.github.com>
No description provided.