Skip to content

Stop calling string sorting broken in inventory_report - #4

Merged
DerekCorniello merged 1 commit into
mainfrom
docs/inventory-report-sorting
Aug 19, 2026
Merged

Stop calling string sorting broken in inventory_report#4
DerekCorniello merged 1 commit into
mainfrom
docs/inventory-report-sorting

Conversation

@DerekCorniello

Copy link
Copy Markdown
Contributor

Found while sweeping for stale references to issues this release closed.

The README said sorting the category names was "not currently possible" because algorithm.sort on a list<string> returned the list unchanged, citing muxlang/mux-compiler#390. That shipped in 0.9.0:

[apple, banana, cherry, pear]

So the example was justifying its design with a bug that no longer exists - and the design does not need that justification. Rewritten as the real reason: first-seen order reports categories in the order the source data introduces them, which is usually what someone reading that data expects, and it needs no second pass.

Verified algorithm.sort on strings against the compiler before changing the claim. Example still passes.

The README said sorting the category names was "not currently possible"
because algorithm.sort on a list<string> returned the list unchanged, and
cited muxlang/mux-compiler#390. That shipped in 0.9.0 - sort now orders
strings correctly - so the note described a bug as the reason for a choice
that stands on its own.

Rewritten as the actual reason: first-seen order reports categories in the
order the source data introduces them, which is usually what someone reading
that data expects, and it needs no second pass.
@greptile-apps

greptile-apps Bot commented Aug 19, 2026

Copy link
Copy Markdown

Greptile Summary

The PR corrects stale documentation that described string sorting as broken and explains first-seen category ordering as a deliberate design choice.

Confidence Score: 5/5

The documentation-only change appears safe to merge.

The revised explanation matches the inventory example’s first-seen ordering implementation, and the PR records direct verification of string sorting against the compiler.

Important Files Changed

Filename Overview
examples/inventory_report/README.md Replaces an obsolete compiler limitation with an accurate explanation of the example’s deliberate first-seen ordering; no actionable issues found.

Reviews (1): Last reviewed commit: "Stop calling string sorting broken in in..." | Re-trigger Greptile

@DerekCorniello
DerekCorniello merged commit 5bd2146 into main Aug 19, 2026
2 checks passed
@DerekCorniello
DerekCorniello deleted the docs/inventory-report-sorting branch August 19, 2026 22:48
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.

1 participant