wingfoil-io/wingfoil

scripts/setup-dev.sh installs protoc and nothing else. But anyone who runs cargo lint-all, cargo test -p wingfoil --all-features, or touches the Aeron adapter also needs clang, libclang-dev, uuid-dev, libbsd-dev and CMake ≥ 3.30. Those instructions currently exist only as a copy-paste block in CLAUDE.md ("Aeron adapter system dependencies"), which means a contributor typically discovers them the expensive way: a long, apparently successful build that ends at link time with rust-lld: error: unable to find library -lbsd libbsd-dev is the one that is easy to miss, because nothing fails until then and only on an --all-features target. CMake fails differently and just as late — the vendored rusteron-media-driver Aeron sources set a 3.30 floor in their own cmake_minimum_required, so the 3.28 that ships on many distros aborts the build script with CMake 3.30 or higher is required. Where to start Teach setup-dev.sh a second mode — a flag or a positional argument, e.g. scripts/setup-dev.

StreamOps::timed (crates/wingfoil/src/fluent.rs, next to print) passes each value through unchanged and prints a performance summary at the end of the run. It is not exposed in Python — grep -rn '\btimed\b' crates/wingfoil-python/src finds only unrelated hits. Its neighbour print is bound, and the two are the same shape, so this is a small, well-modelled first contribution to the Python crate. Where to start PyStream::print in crates/wingfoil-python/src/graph.rs (~line 662) is the model. The binding is one line over the erased PyElement edge plus rustdoc: pub fn timed(&self) -> PyStream { self.wrap(self.stream.timed()) } Check the bound before assuming it compiles: timed wants T: Clone + Default + 'static and PyElement satisfies that (print additionally needs Debug and gets it). If it does not compile, say so on the issue rather than working around it — that would be a real finding about the erased edge. The recipe for the Python step is /new-op §7 (.claude/commands/new-op.md)

Third and last of the doctest issues (see the value-transform and rate/window ones). crates/wingfoil/src/fluent.rs documents ~90 public methods and only 7 carry a runnable example. The multi-input combinators are the ones where prose alone genuinely cannot settle the question — which input ticks the output, what the passive variant holds, who wins a same-instant tie. Every one of those is a two-line assert. Scope On StreamOps, in crates/wingfoil/src/fluent.rs: join, join3, try_join, try_join3 join_passive, try_join_passive merge, merge_all sample, filter Partial PRs are welcome — one method is a valid PR. Where to start Copy the filter_map example in the doc block immediately above fn filter_map in fluent.rs. What each family should actually demonstrate: join vs join_passive — the whole point is the difference. join ticks when either input ticks; join_passive ticks only with the active one and reads the other's held value. One example each, wired over the same two streams, mak

Companion to the value-transform doctest issue. crates/wingfoil/src/fluent.rs documents ~90 public methods and only 7 carry a runnable example, so most of the combinator reference on docs.rs is a sentence and a signature. These particular combinators are the ones most often misread from a one-line description — leading vs. trailing edge, whether the value is dropped or held, whether the node ticks or stays silent — so an example is worth more here than anywhere else. Scope On StreamOps, in crates/wingfoil/src/fluent.rs: audit, window, buffer limit, skip, step_by skip_while, take_while delay throttle is deliberately not on this list — its contract wording is #929, and the example belongs in that PR alongside the prose. Partial PRs are welcome — one method is a valid PR. Where to start Copy the filter_map example in the doc block immediately above fn filter_map in fluent.rs; it is the house shape. Two of these need more care than a copy: delay is the one that demonstrates Tick

crates/wingfoil/src/fluent.rs documents ~90 public methods and only 7 of them carry a runnable example — grep -c '/// ```' crates/wingfoil/src/fluent.rs returns 14 fence lines. docs.rs is where a new user lands first, and for almost every combinator it currently shows a one-line sentence and a signature. This is the cheapest possible improvement to the front door, and it is already gated: cargo test --doc -p wingfoil --all-features runs every fence, so a wrong example fails CI rather than rotting. Scope The value-transform group on StreamOps, in crates/wingfoil/src/fluent.rs: map, try_map, map_filter with_time, ticked_at, ticked_at_elapsed difference, pairwise, enumerate Sibling issues cover the rate/window group and the join/merge group. Partial PRs are welcome — one method is a valid PR. Where to start Copy the existing filter_map example, in the doc block immediately above fn filter_map in fluent.rs. It is the house shape and it is 14 lines: build a graph, drive it from ticker