Skip to content

chore(oi2): pin defaults, docs#460

Merged
agitter merged 3 commits intoReed-CompBio:mainfrom
tristan-f-r:oi2-more-docs
Mar 16, 2026
Merged

chore(oi2): pin defaults, docs#460
agitter merged 3 commits intoReed-CompBio:mainfrom
tristan-f-r:oi2-more-docs

Conversation

@tristan-f-r
Copy link
Collaborator

@tristan-f-r tristan-f-r commented Feb 24, 2026

I was very confused by what 'corrupted data' meant in OI2. Hopefully this saves the next reader some time digging through the OmicsIntegrator2 codebase.

While we're here, we also pin the defaults using values provided by OI2, move dummy_mode documentation over to the enum instead of on the parameter class directly, and correct some summary table serialization issues.

@tristan-f-r tristan-f-r added the documentation Improvements or additions to documentation label Feb 24, 2026
@read-the-docs-community
Copy link

read-the-docs-community bot commented Feb 24, 2026

Documentation build overview

📚 spras | 🛠️ Build #31810450 | 📁 Comparing 8a7fca3 against latest (cd0cd2d)


🔍 Preview build

Show files changed (6 files in total): 📝 5 modified | ➕ 0 added | ➖ 1 deleted
File Status
genindex.html 📝 modified
fordevs/modules.html 📝 modified
fordevs/spras.config.html 📝 modified
fordevs/spras.html 📝 modified
prms/diamond.html ➖ deleted
prms/prms.html 📝 modified

Copy link
Collaborator

@agitter agitter left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The updated comments make sense to me. @ntalluri can double-check too.

We have a test failure though.

@tristan-f-r
Copy link
Collaborator Author

tristan-f-r commented Mar 15, 2026

The failed test was due to an outdated artifact. I took the opportunity to use json.dumps instead (see commit), which makes the key sorting TODO easy and drops the awkward __repr__ only present in oi1's DummyMode but not oi2.

@agitter agitter merged commit f7b6eaf into Reed-CompBio:main Mar 16, 2026
20 checks passed
@tristan-f-r tristan-f-r deleted the oi2-more-docs branch March 16, 2026 19:42
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants