Skip to content

Refactor: rename tl.infer_proteoform_groups() to tl.proteoform_group_inference() - #48

Merged
idf-io merged 1 commit into
mainfrom
refactor/proteoform-inf
Oct 23, 2026
Merged

idf-io merged 1 commit into
mainfrom
refactor/proteoform-inf

Conversation

@idf-io

@idf-io idf-io commented Oct 23, 2026 •

Copy link
Copy Markdown
Collaborator

Summary

Renames pr.tl.infer_proteoform_groups() to pr.tl.proteoform_group_inference() so it follows the noun-style naming of the other pr.tl functions (e.g. pr.tl.peptide_proximity(), pr.tl.proteoform_scores()). Behavior is unchanged.

Related issues

None

General checklist

  • Branch name and commit subjects follow the repo conventions
  • HISTORY.md updated under [Unreleased] (renamed the existing Added entry; the function was never released)
  • CI is green (flake8, pylint, pytest): locally flake8 and pylint (errors only) pass on the changed files and the full test suite passes (665 passed); waiting on CI

♻️ Refactor / style

What was restructured and why:

Only the name changes. Updated: the definition and export (proteopy/tl/proteoform_group_inference.py, proteopy/tl/__init__.py), the docstring references in proteopy/utils/proteoform_group_simulation.py, the Sphinx API entry (docs/sphinx/source/api/tl.rst), HISTORY.md and the tests. One test call was wrapped to stay under 79 characters. No tutorial notebook referenced the old name.

  • No change to public API or numerical results: the public name changes, but the function exists only under [Unreleased], so no released API is affected
  • Existing tests pass unchanged, apart from the renamed calls

Notes for reviewers

  • No deprecated infer_proteoform_groups alias is kept, because the function was never released.
  • The function now has the same name as its module, so proteopy.tl.proteoform_group_inference points to the function, not the module (the same pattern scanpy uses). Nothing in the repo uses the name to reach the module.

🤖 Generated with Claude Code

…inference()

Align the function name with the noun-style naming of the other pr.tl
functions (e.g. peptide_proximity, proteoform_scores). The function is
unreleased, so no deprecation alias is kept.

Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com>
@chatgpt-codex-connector

chatgpt-codex-connector Bot commented Oct 23, 2026 •

Copy link
Copy Markdown

Codex Review Summary

This comment shows the latest Codex review activity on this pull request.

Review Status Commit Review trigger
📝 Code Review ✅ Completed 2026-10-23T08:42:56.517745Z 5c0e0d4 PR opened
ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review" or "@codex security review".

Codex reacts with 👀 while any review is running, comments if it has suggestions, and reacts with 👍 once all reviews finish with no findings.

@idf-io
idf-io merged commit 3d790e4 into main Oct 23, 2026
7 checks passed
@idf-io
idf-io deleted the refactor/proteoform-inf branch October 23, 2026 14:23
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant