A documentation release: the library half of txc is now documented in full,
and the whole crate is held to a stricter set of lints.
Added
- Documentation on every public item. The crate root reads as an
introduction, covering how to run an operation, pass parameters, chain
operations, walk the catalogue and read the errors back. - 100 examples, which run as part of
cargo test, so they cannot go stale. OpFnandParamKindare re-exported from the crate root, so declaring an
operation no longer needs theregistrymodule path.- The dependency audit runs in CI, weekly as well as on every change, since an
advisory can be published without anything here changing. - The documentation is built in CI with warnings denied: a broken link would
otherwise show up only as a mangled page on docs.rs.
Changed
- The crate is linted with
clippy::pedantic, plususe_selfand
missing_const_for_fn. What that fixed is invisible from outside, other
than more functions beingconstand returning values now being
#[must_use]. - Reading time in
statsis worked out in whole numbers. In floating point,
205 words came out as 61 seconds rather than 62, because 61.5 is not
representable and the value landed just below it.
Install
curl -sSf https://raw.githubusercontent.com/vorjdux/txc/main/install.sh | shirm https://raw.githubusercontent.com/vorjdux/txc/main/install.ps1 | iexEvery archive is listed in SHA256SUMS.