Skip to content

Commit f58c781

Browse files
rustyconoverclaude
andcommitted
Clarify example functions are for protocol testing only
Update docstrings to emphasize these are reference implementations for testing VGI protocol conformance, not production-ready code. 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
1 parent 5e4a590 commit f58c781

1 file changed

Lines changed: 19 additions & 6 deletions

File tree

‎vgi/examples/table_in_out.py‎

Lines changed: 19 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,19 @@
1-
"""Example table-in/table-out function implementations.
1+
"""Example table-in/table-out function implementations for testing VGI.
22
3-
This module contains ready-to-use table functions that demonstrate common patterns.
4-
Each function is documented to serve as a reference for implementing new functions.
3+
WARNING: EXAMPLE/TEST FUNCTIONS ONLY
4+
-------------------------------------
5+
These functions are reference implementations for testing and validating the VGI
6+
protocol. They are NOT intended for production use. The VGI protocol will have
7+
multiple implementations (Python, Go, JavaScript), and these examples serve as:
8+
9+
1. Protocol conformance tests - Verify implementations correctly handle the
10+
VGI streaming protocol (DATA, FINALIZE, HAVE_MORE_OUTPUT, etc.)
11+
2. Pattern demonstrations - Show how to implement common function patterns
12+
3. Cross-implementation test cases - Ensure consistent behavior across languages
13+
14+
Production considerations like memory limits, error recovery, and performance
15+
optimizations are intentionally omitted to keep the examples simple and focused
16+
on protocol correctness.
517
618
AVAILABLE FUNCTIONS
719
-------------------
@@ -101,9 +113,10 @@ class BufferInputFunction(TableInOutGeneratorFunction):
101113
buffered_batches: list[pa.RecordBatch]
102114
Accumulates all input batches in memory (instance attribute).
103115
104-
Warning:
105-
-------
106-
Memory usage grows with input size. Not suitable for very large datasets.
116+
Note:
117+
----
118+
This is a test/example function for protocol validation. Memory buffering is
119+
intentional to test the FINALIZE phase of the VGI protocol.
107120
108121
Example:
109122
-------

0 commit comments

Comments
 (0)