Repository navigation
updated doc text - #1
Merged
Merged
Conversation
There was a problem hiding this comment.
🟢 Approval recommended
The CLI transition, import migrations, packaging cleanup, and documentation updates are consistent, with no unresolved blocking issues.
No open issues 🎉
What changed in this PR
Prepares MADCATS 0.13.0 with clearer command-line guidance, updated documentation, and removal of the legacy module name.
Changes:
- Expands command help and standardizes
--partial-read-modetoon/off, preservingassignwith a warning. - Removes the compatibility shim and migrates bundled scripts and packaging to
madcats. - Updates version references and links documentation to the GitHub development record.
| File | Description |
|---|---|
tests/test_madcats.py |
Updates partial-read tests and checks the legacy alias. |
scripts/validate_inferred_design.py |
Imports directly from madcats. |
scripts/madc_to_reference_tags.py |
Imports directly from madcats. |
scripts/analyze_extra_quality.py |
Imports directly from madcats. |
scripts/analyze_dart_only.py |
Imports directly from madcats. |
scripts/analyze_count_vector_matches.py |
Imports directly from madcats. |
README.md |
Links to the GitHub development record. |
pyproject.toml |
Removes the compatibility module from packaging. |
madcats.py |
Updates version, CLI help, and partial-read option handling. |
madc_pipeline.py |
Deletes the legacy compatibility shim. |
docs/src/SUMMARY.md |
Removes the development-reference navigation entry. |
docs/src/reference/validation.md |
Links validation history to the development record. |
docs/src/reference/evidence-model.md |
Updates the development link and denoising wording. |
docs/src/getting-started/installation.md |
Updates the example version output. |
docs/src/development/reference.md |
Removes the embedded development record. |
docs/src/development/contributing.md |
Links directly to the development record. |
docs/src/development/changelog.md |
Documents 0.13.0 and clarifies release history. |
docs/src/development/architecture.md |
Removes the compatibility-shim entry. |
docs/src/commands/generate.md |
Updates option values and denoising descriptions. |
docs/src/citation.md |
Updates the methods example to 0.13.0. |
docs/DEVELOPMENT.md |
Removes the obsolete compatibility-shim statement. |
Review effort: Balanced
This branch was successfully deployed
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
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.
This pull request releases version 0.13.0 of MADCATS and makes significant improvements to the documentation and command-line interface, while removing legacy compatibility code. The key changes include clearer and more consistent command-line help, improved documentation links and descriptions, and the removal of the deprecated
madc_pipeline.pycompatibility shim. The documentation now references a single development record on GitHub, and several option descriptions and defaults have been clarified.Major changes by theme:
Removal of legacy compatibility code
madc_pipeline.pycompatibility module; users and scripts should now import or invokemadcatsdirectly. (madc_pipeline.py)Command-line interface improvements
madcats. (madcats.py) [1] [2] [3] [4] [5] [6]--partial-read-modeoption now useson/offvalues for consistency with other switches; the oldassignvalue is still accepted asonwith a warning. (madcats.py)design,infer-design, andmerge-pairscommands, making their purpose and arguments clearer. (madcats.py) [1] [2] [3]Documentation and changelog updates
README.md,docs/src/development/changelog.md,docs/src/reference/evidence-model.md,docs/src/reference/validation.md,docs/src/development/contributing.md) [1] [2] [3] [4] [5]docs/src/SUMMARY.md,docs/src/development/reference.md) [1] [2]Option and version updates
madcats.py,docs/src/citation.md,docs/src/getting-started/installation.md) [1] [2] [3]--partial-read-mode, denoising distances, and related options in both the help text and documentation. (docs/src/commands/generate.md,docs/src/development/changelog.md,docs/DEVELOPMENT.md,docs/src/reference/evidence-model.md) [1] [2] [3] [4] [5]Minor cleanups
docs/src/development/architecture.md,docs/src/commands/generate.md) [1] [2]