Skip to content

Extend documentation#56

Merged
maleadt merged 8 commits into
mainfrom
tb/docs
May 22, 2026
Merged

Extend documentation#56
maleadt merged 8 commits into
mainfrom
tb/docs

Conversation

@maleadt

@maleadt maleadt commented May 22, 2026

Copy link
Copy Markdown
Collaborator

No description provided.

maleadt and others added 7 commits May 22, 2026 09:52
The procedural-style smoke tests in `dbi.jl` and `cur.jl` previously
created `testdb/` in CWD and only cleaned up if the surrounding
`try/finally` reached the `rm`. Wraps them in `mktempdir` so failures
don't leak the directory.

Drops the `module LMDB_*` wrappers in favour of plain `@testset`. The
modules were a workaround for `struct` re-definition that doesn't apply
when the file is included once per test run; `@testset` provides
sufficient scope and matches the style of `test/dict.jl`.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
Replaces the numbered "tier 1 / 1.5 / 2 / 3" naming throughout source,
docs, and README with the explicit names of the three layers. The
README is rewritten in this naming and the three stale references
(`ms_entries` → `entries`, `mbd_unpack` → `read(MDBValueIO, T)`,
`Cushort(0o644)` → `LMDB.mode_t(0o644)`) are corrected.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
- CI.yml: bump to checkout@v4, setup-julia@v2, julia-actions/cache@v2,
  codecov-action@v5; matrix is lts/1/pre/nightly × ubuntu/macOS/windows;
  drop coveralls; add concurrency group.
- Documenter.yml: pin julia-buildpkg@v1 / julia-docdeploy@v1, add julia
  setup + cache, set the permissions block expected by docdeploy.
- CompatHelper.yml: standard nightly cron.
- README.md: add the conventional CI / codecov / docs-stable / docs-dev
  badge row.
- docs/make.jl: enable doctests via DocMeta.setdocmeta! and doctest=true.
@codecov

codecov Bot commented May 22, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 82.11%. Comparing base (581c7d7) to head (4ba010c).
⚠️ Report is 1 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main      #56   +/-   ##
=======================================
  Coverage   82.11%   82.11%           
=======================================
  Files           9        9           
  Lines         755      755           
=======================================
  Hits          620      620           
  Misses        135      135           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

The test-cleanup commit's finalizer-via-GC.gc() tests in test/env.jl
crash on Windows (EXCEPTION_ACCESS_VIOLATION in mdb_txn_end) and hang
on Linux. Restoring the pre-cleanup test/ shape — module wrappers and
all — keeps this docs/release-prep branch shippable. The cleanup can
return as its own PR with the GC-dependent tests hardened or skipped
on Windows.
@maleadt maleadt merged commit 2910dd9 into main May 22, 2026
1 check passed
@maleadt maleadt deleted the tb/docs branch May 22, 2026 08:48
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