docs: clarify --mode is required for optimized cube reads (#160)#162
Merged
Conversation
A cube read (--tm1-instance) cannot auto-detect its execution mode the way a file source can — every workflow occupies the same measures in the rushti cube. It therefore defaults to norm and silently drops the predecessors measure unless --mode opt is passed, which is why predecessors were missing from cube-read plans like Sample_Optimal_Mode. The docs and CLI help wrongly described --mode as universally deprecated and ignored; that is only true for file sources. Correct the CLI reference, settings reference, migration guide, getting-started task-files page, and rushti run --help, and add a 'Choosing the mode for cube reads' section to the TM1 integration guide. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
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.
Summary
Fixes the documentation gap behind #160. A user ran
Sample_Optimal_Modefrom therushticube and the generated plan dropped allpredecessors.This is a documentation bug, not a code bug. A cube read (
--tm1-instance) cannot auto-detect its execution mode the way a file source can — every workflow occupies the same measures in therushticube, so there's no structural signal to distinguish wait-based (norm) from predecessor-based (opt). Cube reads therefore default tonormand silently drop thepredecessorsmeasure (only a debug-level warning is logged) unless--mode optis passed.The docs and
rushti run --helpwrongly described--modeas universally deprecated/ignored — that's only true for file sources (--tasks).Changes
docs/features/tm1-integration.md— added a warning to "Run Tasks from TM1", fixed theSample_Optimal_Modeexample to use--mode opt, and added a new "Choosing the Mode for Cube Reads" section with a norm-vs-opt table.docs/advanced/cli-reference.md— rewrote the--moderow (ignored for files, required for cube reads) and added an opt cube-read example.docs/advanced/settings-reference.md— corrected themodesetting row and the inlinesettings.inicomment; removed "(deprecated)" from the CLI-overridable list.docs/advanced/migration-guide.md— corrected the "--mode Flag" section and replaced the "Mode Deprecation Warning" troubleshooting entry with "Predecessors Missing When Running from a Cube".docs/getting-started/task-files.md— fixed the cube-read example that usedpredecessorswithout--mode opt.src/rushti/cli.py— corrected the--modehelp text and run epilog; added an opt cube-read example. (No behavioural change.)CHANGELOG.md— added an Unreleased entry.Notes
predecessors ignored in norm modewarning at a more visible log level, but this PR is scoped to docs as discussed on the issue.Closes #160
🤖 Generated with Claude Code