docs: trim Getting Started, remove historical ROADMAP.md, add cost-alert test - #50
Merged
Merged
Conversation
Replace the three inline Getting Started examples (Monte Carlo, bootstrap,
genomics) with a 'Real-world examples' pointer to the measured example articles
and the Workload Shapes / Performance guides. This removes:
- two unbatched future_map(1:10000, ...) anti-pattern calls,
- fabricated '~4 hours local / ~3 min cloud' style speedup claims,
- list.files('s3://...') (base list.files cannot read s3:// URIs).
The remaining 'map over your inputs' examples now iterate a named input vector
instead of a synthetic 1:1000 range, matching how users actually call them.
Close the guard gap that let these slip past: tools/check-docs.R now flags
naive big-count future_map()/future_lapply() calls, not just starburst_map(),
and recognizes 'Instead of:' / tiny-task anti-pattern markers within three lines.
Refs external documentation re-review.
ROADMAP.md was a pre-1.0, week-by-week implementation plan (Fargate-first, with EC2/Spot listed as future work) that no longer matched the shipped system, and it carried a stale 'Package is free (MIT)' note while the package is Apache-2.0. The README Roadmap section is the single source of truth. Also drop its .Rbuildignore entry.
Adds a regression test proving cost_alert_threshold emits a warning but lets the plan proceed (contrast with the max_hourly_cost hard-stop test): with the alert below the estimate and no max cap, execution reaches a stubbed ensure_environment sentinel, and the alert-threshold warning is printed. (should_cleanup_s3() precedence is already covered in test-setup.R.) NEWS: note the Getting Started trim + guard extension and ROADMAP.md removal.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Addresses the latest external documentation re-review (site 9.1/10, full public docs 8.6/10). Every claim was verified against current
mainfirst; two were already resolved (reviewer read a stale checkout), so this PR fixes only the genuinely-open items.What the review flagged, and what was real
future_map(1:10000, …)+ "~4 hours local / ~3 min cloud" claimslist.files("s3://…")(can't read s3://)cost_alert_thresholdwarns-without-stop;should_cleanup_s3()precedenceshould_cleanup_s3precedence already tested; alert-warn path was untested — addedChanges
example-*articles + Workload Shapes / Performance guides. Removes bothfuture_map(1:10000,…)calls, the fabricated timings, and thelist.files("s3://…")line. Remaining "map over inputs" examples now iterate a named input vector instead of a synthetic1:1000range.tools/check-docs.Rnow flags naive big-countfuture_map()/future_lapply()(not juststarburst_map()) and recognizesInstead of:/ tiny-task anti-pattern markers. Verified: it fails on a reintroducedfuture_map(1:10000)and passes after revert..Rbuildignoreentry.cost_alert_thresholdwarns but does not stop the plan.Verification
Rscript tools/check-docs.R→ passes; fails on reintroducedfuture_map(1:10000), passes after revert.devtools::test()→ 284 pass, 0 fail (+ new cost-alert test).future_map(1:10000/list.files("s3://in getting-started;ROADMAP.mdgone.Docs/test-only; no behavior change.