-
Notifications
You must be signed in to change notification settings - Fork 50
Add docs for the new "has_edge_degree" filter operation. #51
Conversation
Looks good to me, but I'm not the |
{ | ||
Animal { | ||
name @output(out_name: "animal_name") | ||
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.
Is there a reason for the newline here? I don't see it anywhere else in the docs under a similar context.
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 not necessary, it just visually separates the output from the meat of the query with the complicated filter. Would you prefer it removed?
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 mostly care about consistency throughout the docs. It is a pretty complicated filter so maybe it's good to keep it.
name @output(out_name: "animal_name") | ||
out_Animal_ParentOf @filter(op_name: "has_edge_degree", value: ["$child_count"]) @optional { | ||
uuid |
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.
Why do we just have uuid
here?
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.
Because we have to have something between the curly braces, to satisfy the GraphQL parser. The uuid
has no effect, since it's not tagged, output, or filtered on.
Should I add an explanation for this?
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.
Yes please! It seems a little out of place.
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.
Sounds good, I'll add a note. Thanks!
* Add UnaryTransformation Expression type, and Literal int values. (#47) * Add UnaryTransformation Expression type. * Improve exception language in operator type check. * Allow @filter directives that apply to the enclosing scope. (#48) * Allow @filter directives that apply to the enclosing scope. An example of such a filtering operator is the upcoming edge degree operator. * Ignore filters that apply to the outer scope at the root of the AST. * Update filter handler functions to use FilterOperationInfo objects. (#49) * Implement the new "has_edge_degree" filter. (#50) * Add docs for the new "has_edge_degree" filter operation. (#51) * Add docs for the new "has_edge_degree" filter operation. * Add a note regarding the unused `uuid` field. * Update the @optional + has_edge_degree docs for clarity.
@MichaelaShtilmanMinkin I'd appreciate your 👀 on this since you already helped write much of the existing documentation.