Skip to content

fix: update stale README command examples (#239)#264

Merged
microsasa merged 1 commit intomainfrom
fix/239-readme-stale-examples-8511ce0a328466cc
Mar 22, 2026
Merged

fix: update stale README command examples (#239)#264
microsasa merged 1 commit intomainfrom
fix/239-readme-stale-examples-8511ce0a328466cc

Conversation

@microsasa
Copy link
Owner

Fixes #239

Updates the example output blocks in README.md to match the current render_live_sessions and render_cost_view implementations in report.py.

Changes

copilot-usage live table (2 fixes):

  • Added the missing Est. Cost column between Messages and Output Tokens (8 columns total, matching the actual render_live_sessions output)
  • Replaced raw comma-formatted token integers with K/M formatted values (468,625468.6K, 483,762483.8K, 1,225,9901.2M) to match format_tokens() output

copilot-usage cost table (1 fix):

  • Changed the "↳ Since last shutdown" row's Premium Cost from N/A to ~3 — the actual code calls _estimate_premium_cost() which returns ~{cost}, not N/A

Verification

All CI checks pass locally: ruff, pyright, and 506 tests with 99% coverage.

Generated by Issue Implementer ·

Warning

⚠️ Firewall blocked 1 domain

The following domain was blocked by the firewall during workflow execution:

  • astral.sh

To allow these domains, add them to the network.allowed list in your workflow frontmatter:

network:
  allowed:
    - defaults
    - "astral.sh"

See Network Configuration for more information.

- Add missing 'Est. Cost' column to copilot-usage live table
- Replace raw comma-formatted token integers with K/M format (468.6K, 483.8K, 1.2M)
- Fix cost 'Since last shutdown' row: show estimated cost (~3) instead of N/A

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
@microsasa microsasa added the aw Created by agentic workflow label Mar 22, 2026
@microsasa microsasa enabled auto-merge March 22, 2026 21:49
Copilot AI review requested due to automatic review settings March 22, 2026 21:49
Copy link

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

Updates the documentation examples in README.md so the shown CLI output matches the current Rich table rendering produced by render_live_sessions() and render_cost_view() in src/copilot_usage/report.py.

Changes:

  • Fixes copilot-usage live README example to include the missing Est. Cost column (8 columns total).
  • Updates Output Tokens formatting in the live example to use the same K/M suffix formatting as format_tokens().
  • Fixes the copilot-usage cost README example so the “↳ Since last shutdown” Premium Cost value reflects the estimated ~{cost} output (instead of N/A).

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

@microsasa microsasa added the aw-quality-gate-approved Quality gate approved the PR label Mar 22, 2026
Copy link
Contributor

@github-actions github-actions bot left a comment

Choose a reason for hiding this comment

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

Quality Gate: APPROVED

Low-impact documentation-only change — updates three stale example output blocks in README.md to match current code.

Verified against source code:

  1. render_live_sessions() includes "Est. Cost" column between Messages and Output Tokens (report.py:210-212)
  2. format_tokens() produces K/M formatted values (report.py:44-61)
  3. _estimate_premium_cost() returns ~{cost} not N/A (report.py:153-168)

Auto-approving for merge.

@microsasa microsasa merged commit 92cf633 into main Mar 22, 2026
8 checks passed
@microsasa microsasa deleted the fix/239-readme-stale-examples-8511ce0a328466cc branch March 22, 2026 21:56
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

aw Created by agentic workflow aw-quality-gate-approved Quality gate approved the PR

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[aw][code health] README command examples are stale (missing column, wrong token format)

2 participants