Skip to content

Repository navigation

[BUG] Correct the Python package documentation #683

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Victor Schappert (vcschapp) merged 5 commits into from
Aug 26, 2026
Merged

[BUG] Correct the Python package documentation #683

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
1068f14
feat(common): tag Overture feature types with `overture`
sethfitz Aug 19, 2026
39a932b
fix(cli): render `--help` example blocks and cite tags that exist
sethfitz Aug 19, 2026
9635641
fix(codegen): name union entry points in `overture-codegen list`
sethfitz Aug 19, 2026
4cf99f8
docs: correct the Python package documentation
sethfitz Aug 19, 2026
e7325f9
test: check the imports and enum members the docs name
sethfitz Aug 19, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
23 changes: 16 additions & 7 deletions Makefile
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
.PHONY: default uv-sync clean-pyspark generate-pyspark check check-namespace test-all test test-only docformat docformat-only doctest doctest-only mypy mypy-only lint-only update-baselines
.PHONY: default uv-sync clean-pyspark generate-pyspark check check-namespace test-all test test-only docformat docformat-only doctest doctest-only mypy mypy-only lint-only format update-baselines

TESTMON ?= --testmon

Expand Down Expand Up @@ -47,13 +47,13 @@ check-namespace:
# the PySpark output first: that tree is no longer tracked in git, so the
# generated conformance tests only exist once generation has run.
test-all: uv-sync generate-pyspark
@uv run pytest -W error packages/
@uv run pytest -W error packages/ tests/

test: uv-sync
@uv run pytest -W error $(TESTMON) packages/ -x -q --tb=short
@uv run pytest -W error $(TESTMON) packages/ tests/ -x -q --tb=short

test-only:
@uv run pytest -W error $(TESTMON) packages/ -x -q --tb=short
@uv run pytest -W error $(TESTMON) packages/ tests/ -x -q --tb=short

coverage: uv-sync
@uv run pytest packages/ --cov overture.schema --cov-report=term --cov-report=html && open htmlcov/index.html
Expand Down Expand Up @@ -90,11 +90,20 @@ mypy-only:
| tr - . \
| sed 's|^packages/|-p |' \
| xargs uv run mypy --no-error-summary
@for d in packages/*/tests; do find "$$d" -name "*.py" | sort | xargs uv run mypy --no-error-summary || exit 1; done
@for d in packages/*/tests tests; do find "$$d" -name "*.py" | sort | xargs uv run mypy --no-error-summary || exit 1; done

lint-only:
@uv run ruff check -q packages/
@uv run ruff format --check packages/
@uv run ruff check -q packages/ tests/
@uv run ruff format --check packages/ tests/
@# Python embedded in Markdown -- keeps documented snippets in the
@# same style as the code they describe.
@git ls-files -z '*.md' | xargs -0 --no-run-if-empty uv run ruff format -q --check

# The fixing counterpart to lint-only: what to run when that gate fires.
format:
@uv run ruff check -q --fix packages/ tests/
@uv run ruff format -q packages/ tests/
@git ls-files -z '*.md' | xargs -0 --no-run-if-empty uv run ruff format -q

update-baselines:
@uv run pytest --update-baselines -m baseline -q packages/
Loading
Loading