Skip to content

docs: update README to match current directory structure#255

Merged
ingomueller-net merged 1 commit intosubstrait-io:mainfrom
bvolpato:bvolpato/fix-readme-stale-paths
Apr 2, 2026
Merged

docs: update README to match current directory structure#255
ingomueller-net merged 1 commit intosubstrait-io:mainfrom
bvolpato:bvolpato/fix-readme-stale-paths

Conversation

@bvolpato
Copy link
Copy Markdown
Member

Summary

The README references paths and files from before the refactor that reorganized the project structure. This PR updates all stale references to match the current codebase.

Closes #248

Changes

  • Test paths: tests/integrationtestdata/integration, tests/functionalfunctional, tests/adhocadhoc
  • Test case format: Python test case modules → JSON files in testdata/function/{group}/{type}/
  • SQL queries: separate .py files → embedded in JSON test case files
  • Ibis expressions: functional/queries/ibis_expressionsibis_expressions/
  • Snapshots: per-extension *_snapshots directories → centralized snapshots/ directory
  • Consumer example typo: producers/duckdb_consumer.pyconsumers/duckdb_consumer.py
  • Python version: 3.9 → 3.12 in conda setup instructions
  • pytest commands: updated to run from project root instead of cd into subdirectories
  • Table of Contents: updated to match renamed sections

Testing

Verified every path referenced in the README against the actual filesystem — all paths now exist.

The README referenced paths and files from before the refactor that
reorganized the project structure. Updated all references:

- tests/integration → testdata/integration
- tests/functional/extension_functions → testdata/function
- tests/adhoc → adhoc
- functional/queries/{*_tests}.py → testdata/function/{group}/{type}/*.json
- functional/queries/sql → SQL embedded in JSON test files
- functional/queries/ibis_expressions → ibis_expressions/
- *_snapshots per extension → centralized snapshots/ directory
- producers/duckdb_consumer.py → consumers/duckdb_consumer.py (typo)
- Python 3.9 → 3.12 in conda setup
- Updated pytest commands to run from project root
- Updated Table of Contents to match renamed sections

Closes substrait-io#248
@ingomueller-net
Copy link
Copy Markdown
Contributor

Wow, this is awesome! Thank you so much!

@ingomueller-net ingomueller-net merged commit bcbc2a4 into substrait-io:main Apr 2, 2026
10 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Development

Successfully merging this pull request may close these issues.

Readme is out of sync with code

2 participants