Updating documentation #84
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
added 2 commits
May 21, 2018 14:04
obi1kenobi
reviewed
May 21, 2018
README.md
Outdated
| Including an optional statement in GraphQL has no performance issues on its own, | ||
| but if you continue traversing within an optional there may be significant performance implications. | ||
| but if you continue expanding vertex fields within an optional, |
There was a problem hiding this comment.
an optional -> an optional vertex field
obi1kenobi
added a commit
that referenced
this pull request
May 21, 2018
* Allowing traversal inside `@optional` scope (#66) * Added Gremlin support for traversing inside @optional. * Added Gremlin support for traversing inside @optional. * Starting optional traversal. * Allowing optional traversal. * Allowing optional traversal. * Fixed isort errors. * Fixed pylint errors. * Temporarily disabled pylint. * Fixed pylint errors. * Simplified Traverse.get_field_name. * Added test case * Disallowed folds inside optional * Added tests for conflicts with directives within @optional. * Added test case for deep optional traverse after a filter. * Fixed lint erroe * Changed 'fold_last_level' to 'fold_innermost_scope', and wrote explicit check for 'fold_innermost_scope' in context at the end of a fold. * Added test cases for traversing inside optional. * Updated compiler_frontend documentation * Fixed lint errors. * Added docstrings. Reverted FoldedOutputContextField. Simplified emit_match. * Changed function names. * Fixed small errors. * Fixed pylint error * Allowing traversal inside `@optional` scope (#66) * Added Gremlin support for traversing inside @optional. * Added Gremlin support for traversing inside @optional. * Starting optional traversal. * Allowing optional traversal. * Allowing optional traversal. * Fixed isort errors. * Fixed pylint errors. * Temporarily disabled pylint. * Fixed pylint errors. * Simplified Traverse.get_field_name. * Added test case * Disallowed folds inside optional * Added tests for conflicts with directives within @optional. * Added test case for deep optional traverse after a filter. * Fixed lint erroe * Changed 'fold_last_level' to 'fold_innermost_scope', and wrote explicit check for 'fold_innermost_scope' in context at the end of a fold. * Added test cases for traversing inside optional. * Updated compiler_frontend documentation * Fixed lint errors. * Added docstrings. Reverted FoldedOutputContextField. Simplified emit_match. * Changed function names. * Fixed small errors. * Fixed pylint error * fixing imports in branch * Removed duplicate functions * Added documentation * Removed Note/Notice * Clarified optional traversal * Fixed documentation. * Spell checked. * Optional traversal fixes (#69) * Added Gremlin support for traversing inside @optional. * Added Gremlin support for traversing inside @optional. * Starting optional traversal. * Allowing optional traversal. * Allowing optional traversal. * Fixed isort errors. * Fixed pylint errors. * Temporarily disabled pylint. * Fixed pylint errors. * Simplified Traverse.get_field_name. * Added test case * Disallowed folds inside optional * Added tests for conflicts with directives within @optional. * Added test case for deep optional traverse after a filter. * Fixed lint erroe * Changed 'fold_last_level' to 'fold_innermost_scope', and wrote explicit check for 'fold_innermost_scope' in context at the end of a fold. * Added test cases for traversing inside optional. * Updated compiler_frontend documentation * Fixed lint errors. * Fixed multiple concurrent filters for same location issue. Added test case for the same. * Added test case for query involving optionals with and without a traversal. * Added docstrings. Reverted FoldedOutputContextField. Simplified emit_match. * Changed function names. * Fixed multiple concurrent filters for same location issue. Added test case for the same. * Added test case for query involving optionals with and without a traversal. * Fixed small errors. * Fixed multiple concurrent filters for same location issue. Added test case for the same. * Added test case for query involving optionals with and without a traversal. * Fixed multiple concurrent filters for same location issue. Added test case for the same. * Fixed pylint error * Fixed multiple concurrent filters for same location issue. Added test case for the same. * Added test case for query involving optionals with and without a traversal. * Fixed multiple concurrent filters for same location issue. Added test case for the same. * Fixed multiple concurrent filters for same location issue. Added test case for the same. * Fixed multiple concurrent filters for same location issue. Added test case for the same. * Added test case for query involving optionals with and without a traversal. * Fixed merge conflict. * Fixed lint error * Fixed errors from previous PR(#66) * Fixed errors * Fixed flake8 errors * Making nested function private * Fixed docstring * Started ficx for apllowing tags inside optional traverse. * Making nested function private underscored * Started ficx for apllowing tags inside optional traverse. * Tags allowed inside optional traversal * Added test cases for tags inside optional traversal * Allowing Recursion within optional traversal. Gremlin support might need an update in blocks.Recurse * Fixed lint error * Fixed lint error * Added simple test-case for Recursion within optional traversal. * Fixed CopySplit indentation * Fixed CopySplit indentation * Allowing Brached traversals within optional * Fixed IR generation test cases to inclue EndOptional blocks. * Removed dead code. Fixed lint errors * Fixed flake8 error. * Fixed pytlint errors. * Fixed imports * Extracted tag update visitor functions. * Addresed comments * Fixed iteritems error * Decomposed function collect_filters_to_first_location_instance * Decomposed function lower_filters_in_compound_match_query * Added check for BetweenClause in _update_tagged_expression * Added comment * Addressed PR comments. Simplified location_to_optional_generation. * Removed check for previous_block is None. * replaced current_locations with present_locations. * Made better docstrings * Removed TODO comments. * Removed mentions of tag from ir_lowering_match * Addressed comments. * Addressed comments. * Removed redundant check. * Fixed indentation in within_optional_scope_validation * Clarifying _prune_traverse_using_omitted_locations * Clarifying convert_optional_traversals_to_compound_match_query * Clarifying prune_output_blocks_in_compound_match_query * Clarifying prune_output_blocks_in_compound_match_query * Addressed comments for ir_lowering_common. * Removed hyphens from docstrings. * Fixed isort errors. * Addressing comments in convert_optional_traversals_to_compound_match_query * Fixed string formatting * Addressing comments predicates to filters. * Addressing comments predicates to filters. * fixing docstrings * Addressing comments predicates to filters. * Using partial * Adding blank lines * Adding comments * Fixing MATCH indentation * Added missing tests in `test_compiler` and `test_ir_generation` (#73) * Added missing tests * Fixed flake8 error. * Fixed MATCH formatting * Addressing comments. * Fixed overfull lines. * Fixed line merges. * Addressed comments from PR. * Restructuring `MATCH` and `Gremlin` lowering into respective directories (#76) * Moved lowering steps for optional traversal into new file. * Restructured lowering code. * Removed BetweenClause from ir_lowering_match * removed unused import * removed unused import * Renamed files * Adding missing files * Added docstrings, comments and changed variable names. (#77) * Added docstring, comments and changed variable names. * Added assertion that optional traverse locations must be mapped to an optional root location. * Fixing Assertion for Folded OutputContextField in optional traversal. * Addressing comments. * Adding missing tests for optional traversals. (#80) * Added docstring, comments and changed variable names. * Added assertion that optional traverse locations must be mapped to an optional root location. * Fixing Assertion for Folded OutputContextField in optional traversal. * Addressing comments. * Added more test cases * Fixed MATCH formatting * Fixed MATCH formatting * Fixed MATCH formatting * Fixed MATCH formatting * Fixed MATCH formatting * Fixed FoldScopeLocation Error * Fixed FoldScopeLocation Error * Fixing formatting * Adding comma * Optional traversal test input data output names fix (#82) * Fixed output names * Fixed spouse_name * Fixed spouse_name * Fixed lint errors * Updating documentation (#84) * Updated documentation * Updated documentation * Updated documentation
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
No description provided.