Skip to content

Update README for the 0.6 CLI and library - #533

Open
rye wants to merge 1 commit into
pr/cli-optionsfrom
pr/readme
Open

rye wants to merge 1 commit into
pr/cli-optionsfrom
pr/readme

Conversation

@rye

@rye rye commented Nov 13, 2026 •

Copy link
Copy Markdown
Owner

README update for 0.6:

  • CLI usage for every flag, exit statuses, and argument pass-through.

  • Installing: cargo install eb, and library-only use with default-features = false.

  • Replaces the algorithm explanation: "either 0 or 1 slot times" described discrete selection, not eb's continuous default. The new summary is accurate and links to the eb::backoff docs.

  • Library usage with blocking and async examples.

  • The README's Rust examples are compiled as doctests (ReadmeDoctests in lib.rs), so they can't drift from the API. The license block is tagged as text.

  • License notice now says GPL version 3 only, matching Cargo.toml's GPL-3.0-only (it previously said "or (at your option) any later version"). Copyright updated to 2019–2026.

Verification: fmt, clippy, all tests, doctests (README included), rustdoc -D warnings, Rust 1.88.


Stack (merge bottom-up; each PR targets the one below it):

@codecov

codecov Bot commented Nov 13, 2026 •

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 95.26%. Comparing base (9d92678) to head (4d2c955).

Additional details and impacted files
@@               Coverage Diff               @@
##           pr/cli-options     #533   +/-   ##
===============================================
  Coverage           95.26%   95.26%           
===============================================
  Files                   5        5           
  Lines                1057     1057           
===============================================
  Hits                 1007     1007           
  Misses                 50       50           

☔ View full report in Codecov by Harness.
📢 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.

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Note

Copilot was unable to complete this review at the selected tier due to model policy or plan restrictions.

🔵 Needs a closer look

A remaining documentation inconsistency needs resolution because the edited README license notice says “GPLv3 or later” while Cargo.toml declares the SPDX license as “GPL-3.0-only,” leaving the project’s licensing intent unclear.

No open issues 🎉

What changed in this PR

Updates the README for the 0.6 CLI and library APIs, and ensures the README’s Rust examples remain API-accurate by compiling them as doctests.

Changes:

  • Expanded CLI documentation (flags, argument pass-through, and exit-status behavior).
  • Updated install guidance and refreshed the backoff/algorithm explanation with links to eb::backoff docs.
  • Added blocking and async library usage examples and wired README Rust snippets into doctest execution.
File Description
src/​lib.rs Adds a doctest-only include/harness so the README’s Rust snippets are compiled and tested against the crate API.
README.md Overhauls documentation for the 0.6 CLI and library (usage, installation, algorithm summary, and examples) and adjusts fences to support doctesting.

Review effort: Balanced

@rye
rye added this pull request to stack #534 November 13, 2026 01:43
- CLI usage for every flag, exit statuses, and argument pass-through.
- Installing: cargo install eb, and library-only use with
  default-features = false.
- Replace the algorithm explanation ("either 0 or 1 slot times"
  described discrete selection, not eb's continuous default) with an
  accurate summary linking to the eb::backoff module docs.
- Library usage with blocking and async examples.
- Compile the README's Rust examples as doctests so they track the API,
  and tag the license block as text.
- License notice: GPL version 3 only, matching Cargo.toml's
  GPL-3.0-only (it said "or any later version"); copyright 2019-2026.
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.

2 participants