Visitar URL original
bindings docs: development and testing pages match the tests, scripts, and workflows (#62) by tae898 · Pull Request #63 · humemai/arcadedb-embedded-python · GitHub
Skip to content

bindings docs: development and testing pages match the tests, scripts, and workflows (#62) - #63

Merged
tae898 merged 1 commit into
mainfrom
docs/dev-testing-sweep-20261002
Oct 2, 2026
Merged

tae898 merged 1 commit into
mainfrom
docs/dev-testing-sweep-20261002

Conversation

@tae898

@tae898 tae898 commented Oct 2, 2026

Copy link
Copy Markdown

Closes #62.

The development and testing pages now match what the tests, scripts, and workflows do. Each audit finding was checked against the files before it was applied; one was skipped because its premise was false (auto-transaction is off by default in the engine, so the best-practices page's "may fail" is correct).

  • Testing pages: every claim that a test asserts something it does not is corrected; per-page test counts and positional references are removed; tests, CI jobs, and build steps no page covered are described.
  • Build and release docs: the JAR directory path points at the full assembly, uv commands match pyproject (--no-group examples on both uv sync and uv run), and dated narrative is retired.
  • Comment and text-only changes outside docs: the graph_export pytest marker is registered in the root pyproject; build.sh's usage and help text; three test docstrings or comments that described asserts the tests do not make; two workflow header comments. No logic, assertion, workflow step, or dependency changed.

Checks: mkdocs build --strict passes with no warnings; every relative link and anchor in the edited pages resolves; edited Python files compile, build.sh passes bash -n, the workflows parse as YAML, and pyproject parses as TOML.

Left for separate review (code changes, not docs): the CI import-skip guard's two escapes, the bindings workflow's upload paths, the examples workflow's dependency on a script the upstream branch excludes, build_and_install_locally.sh staging the headless assembly, build-native.sh's jmods path, test_wheel_platform_tag.py returning instead of skipping, and the unused redis test dependency.

🤖 Generated with Claude Code

https://claude.ai/code/session_01WWcDr7TwvcfMsQkeYQVHZr

…, and workflows (sweep 2026-10-02)

Asserts corrected: testing pages no longer claim asserts the tests do not
make (to_json_list batches, to_dataframe path, first() amount, parallel
flush workers, exporter header and LINK, RDF import, Arrow bools, async
getters, vectorNeighbors without FROM, schema reopen and idempotence,
naive datetimes, numpy query read-back, "persisted" writes, second-pass
timing, HASH skips, jar provenance, server-patterns timings, overview
geo and large-result bullets, cross-model atomicity arms).

Build instructions: JAR_LIB_DIR path points at the full assembly's lib;
JAR_LIB_DIR is build.sh's third argument (an env var is ignored) and
Linux-only; headless assembly caveat; Quick Starts say to build a cp312
wheel first and run from the root or bindings/python; native build
requirements and the in-place pyproject.toml rewrite; the version suffix
comes from the tag through BUILD_VERSION; formatting through pre-commit.

Holes filled: every "See the source" placeholder replaced with what the
test asserts; docs-example test coverage; Skips section; writing a test
for this suite (fixtures, guards, one JVM, importorskip, hang
diagnostics, Bandit); fixed ports; Docker stages; CI test run; examples
workflow behaviour; architecture exports, JVM defaults, ResultSet close,
type table, jar exclusions; bridge internals; dev-environment
troubleshooting and log locations.

Stale retired: per-page test counts and positional test references;
dated "until 2026-..." narrative; unsourced timings; the wrong bash
counter advice and the Common Issues history in build-architecture.md;
RESTORE and schema-batching history; GraphML/GraphSON listed as export
formats.

CI/release docs: Example 21 runs at reduced scale; publish job
continue-on-error and docs deploy not waiting for the release; artifact
names and retention; import-skip gate scope; examples Bandit command;
upstream PR branch scope and pre-commit command; unpinned docs deploy;
log location.

Comment-only code fixes: graph_export marker registered in the root
pyproject.toml; build.sh header path, usage text for native builds, and
next-step hints; test_vector_delta_visibility.py docstring (COST is not
asserted); test_vector.py and test_vector_sql.py comments that
contradicted or overstated their asserts; stale Example 21 comment in
test-python-examples.yml; test-python-bindings.yml header about
sync-upstream.sh.

Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01WWcDr7TwvcfMsQkeYQVHZr
@tae898
tae898 merged commit 6278ea3 into main Oct 2, 2026
48 checks passed
@tae898
tae898 deleted the docs/dev-testing-sweep-20261002 branch October 2, 2026 03:46
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.

bindings docs: development and testing pages drift from the tests, scripts, and workflows

1 participant