powersemmi / ruststream / 32860796452
98%

DEFAULT BRANCH: main
Ran
Jobs 1
Files 90
Run time 1min
Badge
Embed ▾
README BADGES
x

If you need to use a raster PNG badge, change the '.svg' to '.png' in the link

Markdown

Textile

RDoc

HTML

Rst
coverage: 96.645% (+96.6%) from 0.0%
32860796452

push

github

web-flow 
docs: say what the API is, not why (#269)

* docs: say what the API is, not why

Rustdoc and comments across the core carried paragraphs written for a
reviewer: rationale for a design, what the alternative would have cost,
what an item outlived. Cut those and keep the reader-facing half - what
the item is, how to call it, and the one-line constraints a future editor
needs.

* docs: trim the pages to what the reader needs

* docs: say what the API is, not why

A second pass over the rustdoc and comments: drop the paragraphs that
argued a design to a reviewer - rejected alternatives, coherence and
specialization as argument, cost reassurances, refactor and issue
history - and keep the reader-facing half. Stale feature-gate notes that
had been copied into files with no gated import go with them.

* docs: mirror the trim into the Russian tree

* docs: state costs as facts, not derivations

* docs: mirror the trim into the Chinese tree

* docs: mirror the cost pass into the Russian tree

* docs: sweep the Russian tree for calques and terminology

The pub/sub pair is now the actor pair it names in Russian, capability
traits are trait compatibilities against the abilities a broker natively
has, batches settle on one word, and the ladder metaphor gives way to the
established typestate vocabulary. Consuming a value is stated as ownership
transfer, kept apart from consuming messages, which the tree already said
correctly. Transport, household and cost metaphors give way to the
mechanism each one stood for. Publisher, capability and batch are locked
in the glossary so the i18n check enforces the renderings.

* docs: position the memory broker as a real queue, not a test rig

MemoryBroker is a complete broker that happens to run in-process, and the
pages sold it as a convenience for examples, unit tests and prototypes.
That framing belongs to TestApp, which is what emulates a broker for
handler tests. The broker pages now state what it is: the queue you reach
for... (continued)

10861 of 11238 relevant lines covered (96.65%)

266.65 hits per line

Jobs
ID Job ID Ran Files Coverage
1 32860796452.1 90
96.65
 GitHub Action Run
Source Files on build 32860796452