-
Notifications
You must be signed in to change notification settings - Fork 64
Update show output column lists #464
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
Update show output column lists #464
Conversation
|
Looks like you've updated the documentation! Check out your changes at https://neo4j-docs-cypher-464.surge.sh |
|
I started writing a CIP for a typeOf function this morning, where a function will be outputting the Type as a string. In the CIP I have written my initial recommendations to match how the type system is looking (and will most likely not be final), but part of that would be someone would go through the docs and make all the types consistent with the output of this eventual function (and probably update procedure signatures in the future). The things that stick out to me here is the decision on LISTs and MAPs, I have suggested we do LIST and RECORD to match more closely the Cypher Types CIP. You have also used LONG, which is not in the type system as such, I guess this should be INTEGER. Then DATETIME might be good as ZONED DATETIME or LOCAL DATETIME? It would be good to get those type CIPs finalised for this 😅 |
|
I find The datetime is new and in this case it's zoned ones, I guess I can add that but at the moment we only refer to them as
It sure would XD
I wonder if it is better to be consistent with what we have for now, especially since it's ongoing work, and just update it when everywhere get's updated? Cause I can see users being confused by the Looking further at types:
this do argue if favor of switching |
|
I agree about Map and have updated the CIPs as such :) I think we can maybe keep as is and do one big docs update along with the implementation of the Cypher Types? Then everything is consistent at the same time |
modules/ROOT/pages/databases.adoc
Outdated
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 think we missed documenting options field at the time, not sure if it's a separate PR or not though.
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 decided it was a separate one XD
It's kinda part of a feature which feature flag is turned off and therefore undocumented. Maybe it should be documented separately excluding any mentions of the feature but it feels like a separate task from this PR
ali-ince
left a comment
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.
looks good to me.
- error was renamed and updated to statusMessage for SHOW DATABASES - the currentQueryIdleTime for SHOW TRANSACTIONS is a duration, not a long
Co-authored-by: Ali Ince <ali-ince@users.noreply.github.com>
a109b7e to
1f76042
Compare
JPryce-Aklundh
left a comment
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.
Looks great @Hunterness!
I just have a few suggestions.
As for your question, I don't think moving Type between Column and Description is necessary in this case. As far as I can see, the improvement would only be very marginal (e.g. where the value is BOOLEAN, it would maybe make sense for readers to know that before a description that says "if true" in front of it, but it is still coherent and comprehensible as it stands).
@JPryce-Aklundh The thing that triggered the question for me was the default labels in the description which is in the middle of the table, where previously they had been at the end. But I'm fine leaving it as is as well. |
Co-authored-by: Jens Pryce-Åklundh <112686610+JPryce-Aklundh@users.noreply.github.com>
Original PR: #464 Cherry-pick excludes 5.6 specific content in original PR Co-authored-by: Therese Magnusson <therese.magnusson@neotechnology.com>
Original PR: neo4j#464 Cherry-pick excludes 5.6 specific content in original PR Co-authored-by: Therese Magnusson <therese.magnusson@neotechnology.com>
Questions for reviewers: