Skip to content

docs(gfql): Rename chain() to gfql() throughout documentation#748

Merged
lmeyerov merged 3 commits into
masterfrom
docs/pr719-improvements
Sep 26, 2025
Merged

docs(gfql): Rename chain() to gfql() throughout documentation#748
lmeyerov merged 3 commits into
masterfrom
docs/pr719-improvements

Conversation

@lmeyerov

Copy link
Copy Markdown
Contributor

Summary

This PR renames all chain() and chain_remote() method calls to gfql() and gfql_remote() throughout the documentation, implementing the deprecation announced in the CHANGELOG.

Changes

Method Renames

  • ✅ Renamed all g.chain() references to g.gfql()
  • ✅ Renamed all g.chain_remote() references to g.gfql_remote()
  • ✅ Updated method references in spec documentation
  • ✅ Preserved Chain class references (not method calls)

Documentation Updates

  • ✅ Added migration notes to CHANGELOG.md with clear before/after examples
  • ✅ Updated 15 documentation files across:
    • User guides (cheatsheet, 10min, overview, etc.)
    • GFQL documentation (about, combo, quick, remote, etc.)
    • Specification files (language, python_embedding, wire_protocol, cypher_mapping)
    • Example files (datetime_filtering, wire_protocol_examples)

Migration Guide

Added to CHANGELOG.md:

### Breaking 🔥
* GFQL: Renamed `chain()` methods to `gfql()` for clarity
  * **Migration required**: Update your code as follows:
    * `g.chain([...])``g.gfql([...])`
    * `g.chain_remote([...])``g.gfql_remote([...])`
  * The Chain class itself remains unchanged
  * This change makes the API more intuitive as 'gfql' directly indicates Graph Frame Query Language operations

Process

  • Each change was manually inspected for semantic correctness
  • No automated find/replace was used to ensure quality
  • Chain class references were preserved (only method calls were renamed)

Related PRs

Testing

  • Documentation builds successfully
  • All examples use correct new syntax
  • Migration guide is clear

🤖 Generated with Claude Code

Co-Authored-By: Claude noreply@anthropic.com

lmeyerov and others added 3 commits September 25, 2025 16:28
- Renamed all g.chain() references to g.gfql()
- Renamed all g.chain_remote() references to g.gfql_remote()
- Added migration notes to CHANGELOG.md
- Updated method references in spec documentation
- Preserved Chain class references (not method calls)
- Manual inspection of each change for semantic correctness

This change aligns with the deprecation of chain() methods in favor
of the clearer gfql() naming convention.

🤖 Generated with [Claude Code](https://claude.ai/code)

Co-Authored-By: Claude <noreply@anthropic.com>
- Enhanced cypher_mapping.md introduction with clearer structure
- Added GFQL-Only Super-Powers section highlighting unique features
- Improved section headers and organization
- Added comment to edge patterns table about upper-bound only
- Reordered predicates table with literal first
- Added DataFrame-native explanation to translate.rst
- Added reference to loading-graph-data guide

These improvements make the documentation clearer and more comprehensive
for users migrating from Cypher to GFQL.

🤖 Generated with [Claude Code](https://claude.ai/code)

Co-Authored-By: Claude <noreply@anthropic.com>
Removed the reference to :ref:`loading-graph-data` as the file doesn't
exist yet. The DataFrame-native explanation remains to help users
understand GFQL's approach.

🤖 Generated with [Claude Code](https://claude.ai/code)

Co-Authored-By: Claude <noreply@anthropic.com>
@lmeyerov
lmeyerov merged commit 440d0ef into master Sep 26, 2025
25 checks passed
@lmeyerov
lmeyerov deleted the docs/pr719-improvements branch September 26, 2025 04:25
lmeyerov added a commit that referenced this pull request Sep 26, 2025
…chain()

- Replaced all .chain() calls with .gfql()
- Replaced all .chain_remote() calls with .gfql_remote()
- Updated references to chain_remote() and chain_remote_shape() in text
- Updated code examples in markdown cells

Affected notebooks:
- benchmark_hops_cpu_gpu.ipynb: 31 chain() replacements
- gfql_remote.ipynb: 1 chain() + 8 chain_remote() replacements
- gfql_validation_fundamentals.ipynb: 6 chain() replacements
- GPU_memory_consumption_tutorial.ipynb: 1 chain() replacement
- temporal_predicates.ipynb: 7 chain() replacements

This aligns notebooks with the API deprecation from PRs #748 and #750.

🤖 Generated with Claude Code

Co-Authored-By: Claude <noreply@anthropic.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant