Repository navigation
Depricate intervals and mode #106
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
goruha
merged 4 commits into
002-decompose-intervals-pipeline
from
003-cleanup-intervals-pipeline
Apr 19, 2026
Merged
Changes from 1 commit
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
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
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
This file was deleted.
Oops, something went wrong.
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,3 @@ | ||
| ::: foapy.intervals_chain | ||
|
|
||
| See also: [Intervals Chain — Bounded](../fundamentals/order/intervals_chain/bounded.md) · [Intervals Chain — Cycled](../fundamentals/order/intervals_chain/cycled.md) | ||
|
goruha marked this conversation as resolved.
Resolved
|
||
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,3 @@ | ||
| ::: foapy.intervals_distribution | ||
|
|
||
| See also: [Intervals Distribution](../fundamentals/order/intervals_distribution/index.md) | ||
|
goruha marked this conversation as resolved.
Resolved
|
||
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,3 @@ | ||
| ::: foapy.intervals_tuple | ||
|
|
||
| See also: [Intervals Distribution](../fundamentals/order/intervals_distribution/index.md) | ||
|
goruha marked this conversation as resolved.
Resolved
|
||
This file was deleted.
Oops, something went wrong.
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,3 @@ | ||
| ::: foapy.ma.intervals_chain | ||
|
|
||
| See also: [Intervals Chain — Bounded](../../fundamentals/order/intervals_chain/bounded.md) · [Intervals Chain — Cycled](../../fundamentals/order/intervals_chain/cycled.md) | ||
|
goruha marked this conversation as resolved.
Resolved
|
||
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,3 @@ | ||
| ::: foapy.ma.intervals_distribution | ||
|
|
||
| See also: [Intervals Distribution](../../fundamentals/order/intervals_distribution/index.md) | ||
|
goruha marked this conversation as resolved.
Resolved
|
||
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,3 @@ | ||
| ::: foapy.ma.intervals_tuple | ||
|
|
||
| See also: [Intervals Distribution](../../fundamentals/order/intervals_distribution/index.md) | ||
|
goruha marked this conversation as resolved.
Resolved
|
||
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,19 @@ | ||
| ::: foapy.tuple_mode | ||
| options: | ||
| show_signature_annotations: false | ||
| members_order: source | ||
| show_docstring_examples: false | ||
| show_source: false | ||
| show_symbol_type_heading: false | ||
| show_symbol_type_toc: false | ||
|
|
||
| ::: foapy.tuple_mode | ||
| options: | ||
| show_root_heading: false | ||
| show_docstring_description: false | ||
| show_docstring_attributes: false | ||
| show_root_toc_entry: false | ||
| filters: | ||
| - foapy.tuple_mode | ||
|
|
||
| See also: [Lossy distribution](../fundamentals/order/intervals_distribution/lossy.md) · [Redundant distribution](../fundamentals/order/intervals_distribution/redundant.md) | ||
|
goruha marked this conversation as resolved.
Resolved
|
||
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
34 changes: 34 additions & 0 deletions
34
specs/003-cleanup-intervals-pipeline/checklists/requirements.md
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,34 @@ | ||
| # Specification Quality Checklist: Cleanup Intervals Pipeline | ||
|
|
||
| **Purpose**: Validate specification completeness and quality before proceeding to planning | ||
| **Created**: 2026-04-19 | ||
| **Feature**: [spec.md](../spec.md) | ||
|
|
||
| ## Content Quality | ||
|
|
||
| - [x] No implementation details (languages, frameworks, APIs) | ||
| - [x] Focused on user value and business needs | ||
| - [x] Written for non-technical stakeholders | ||
| - [x] All mandatory sections completed | ||
|
|
||
| ## Requirement Completeness | ||
|
|
||
| - [x] No [NEEDS CLARIFICATION] markers remain | ||
| - [x] Requirements are testable and unambiguous | ||
| - [x] Success criteria are measurable | ||
| - [x] Success criteria are technology-agnostic (no implementation details) | ||
| - [x] All acceptance scenarios are defined | ||
| - [x] Edge cases are identified | ||
| - [x] Scope is clearly bounded | ||
| - [x] Dependencies and assumptions identified | ||
|
|
||
| ## Feature Readiness | ||
|
|
||
| - [x] All functional requirements have clear acceptance criteria | ||
| - [x] User scenarios cover primary flows | ||
| - [x] Feature meets measurable outcomes defined in Success Criteria | ||
| - [x] No implementation details leak into specification | ||
|
|
||
| ## Notes | ||
|
|
||
| - All items pass. Spec is ready for `/speckit.plan`. |
71 changes: 71 additions & 0 deletions
71
specs/003-cleanup-intervals-pipeline/contracts/api-changes.md
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,71 @@ | ||
| # API Contract: Cleanup Intervals Pipeline | ||
|
|
||
| **Branch**: `003-cleanup-intervals-pipeline` | **Date**: 2026-04-19 | ||
|
|
||
| ## Public API Diff | ||
|
|
||
| ### Removed from `foapy` namespace | ||
|
|
||
| ```python | ||
| # REMOVED — raises ImportError after this change | ||
| from foapy import intervals # was: intervals(X, binding, mode) -> ndarray | ||
| from foapy import mode # was: mode.lossy / mode.normal / mode.cycle / mode.redundant | ||
| from foapy import is_valid_intervals_chain # was: is_valid_intervals_chain(chain) -> bool | ||
| ``` | ||
|
|
||
| ### Removed from `foapy.ma` namespace | ||
|
|
||
| ```python | ||
| # REMOVED — raises ImportError after this change | ||
| from foapy.ma import intervals # was: intervals(X, binding, mode) -> list[ndarray] | ||
| ``` | ||
|
|
||
| ### Unchanged in `foapy` namespace | ||
|
|
||
| ```python | ||
| from foapy import intervals_chain # intervals_chain(X, binding, chain_mode) -> ndarray | ||
| from foapy import intervals_tuple # intervals_tuple(chain, binding, tuple_mode) -> ndarray | ||
| from foapy import intervals_distribution # intervals_distribution(intervals_tuple) -> ndarray | ||
| from foapy import chain_mode # chain_mode.boundary | chain_mode.cycle | ||
| from foapy import tuple_mode # tuple_mode.lossy | tuple_mode.normal | tuple_mode.redundant | ||
| from foapy import binding # binding.start | binding.end | ||
| from foapy import order # order(X) -> ndarray | ||
| from foapy import alphabet # alphabet(X) -> ndarray | ||
| ``` | ||
|
|
||
| ### Unchanged in `foapy.ma` namespace | ||
|
|
||
| ```python | ||
| from foapy.ma import intervals_chain | ||
| from foapy.ma import intervals_tuple | ||
| from foapy.ma import intervals_distribution | ||
| from foapy.ma import order | ||
| from foapy.ma import alphabet | ||
| ``` | ||
|
|
||
| --- | ||
|
|
||
| ## Mode Mapping Reference | ||
|
|
||
| The following table documents the equivalence between the retired `mode` enum and the decomposed pipeline. This is the contract verified by the equivalence test module. | ||
|
|
||
| | Old call | Decomposed equivalent | | ||
| |----------|----------------------| | ||
| | `intervals(X, b, mode.lossy)` | `intervals_tuple(intervals_chain(X, b, chain_mode.boundary), b, tuple_mode.lossy)` | | ||
| | `intervals(X, b, mode.normal)` | `intervals_tuple(intervals_chain(X, b, chain_mode.boundary), b, tuple_mode.normal)` | | ||
| | `intervals(X, b, mode.cycle)` | `intervals_tuple(intervals_chain(X, b, chain_mode.cycle), b, tuple_mode.normal)` | | ||
| | `intervals(X, b, mode.redundant)` | `intervals_tuple(intervals_chain(X, b, chain_mode.boundary), b, tuple_mode.redundant)` | | ||
|
|
||
| --- | ||
|
|
||
| ## Test-Helper Availability | ||
|
|
||
| The retired `intervals()` functions are available **only** within the test suite: | ||
|
|
||
| ```python | ||
| # Available in tests ONLY — not a public API | ||
| from tests.helpers.intervals import intervals, mode | ||
| from tests.helpers.ma_intervals import intervals as ma_intervals | ||
| ``` | ||
|
|
||
| These helpers MUST NOT be imported from any production source file. |
Oops, something went wrong.
Oops, something went wrong.
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.
Uh oh!
There was an error while loading. Please reload this page.