Skip to content

refactor: apply python coding instructions repo-wide#194

Merged
kelly-sovacool merged 5 commits into
mainfrom
coding-standards
Jun 10, 2026
Merged

refactor: apply python coding instructions repo-wide#194
kelly-sovacool merged 5 commits into
mainfrom
coding-standards

Conversation

@kelly-sovacool

@kelly-sovacool kelly-sovacool commented Jun 10, 2026

Copy link
Copy Markdown
Member

Changes

  • Reviewed the new Python coding instructions and updated Python files across the repository to comply with them.
  • Added missing public-function docstrings where needed.
  • Refactored affected functions to follow the new control-flow requirements, including using a single final return where applicable and removing break / continue usage without changing intended behavior.
  • Verified the changes with pre-commit run --all-files and targeted pytest coverage for the refactored modules.
  • Confirmed full python -m pytest still only shows the same pre-existing network-restricted GitHub API failures seen at baseline.

Issues

  • No new functionality was added; this PR now covers both introducing the Python instructions and applying them across the existing Python code.

PR Checklist

(Strikethrough any points that are not applicable.)

  • This comment contains a description of changes with justifications, with any relevant issues linked.
  • [ ] Write unit tests for any new features, bug fixes, or other code changes.
  • [ ] Update docs if there are any API changes.
  • [ ] Update CHANGELOG.md with a short description of any user-facing changes and reference the PR number. Guidelines: https://keepachangelog.com/en/1.1.0/

@codecov

codecov Bot commented Jun 10, 2026

Copy link
Copy Markdown

Codecov Report

❌ Patch coverage is 75.00000% with 14 lines in your changes missing coverage. Please review.
✅ Project coverage is 73.60%. Comparing base (908f451) to head (ed31893).

Files with missing lines Patch % Lines
src/ccbr_tools/pipeline/util.py 46.15% 7 Missing ⚠️
src/ccbr_tools/GSEA/ncbr_huse.py 0.00% 5 Missing ⚠️
src/ccbr_tools/homologfinder/hf.py 0.00% 2 Missing ⚠️
Additional details and impacted files
@@            Coverage Diff             @@
##             main     #194      +/-   ##
==========================================
+ Coverage   73.47%   73.60%   +0.12%     
==========================================
  Files          28       28              
  Lines        1938     1936       -2     
==========================================
+ Hits         1424     1425       +1     
+ Misses        514      511       -3     

☔ View full report in Codecov by Harness.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@kelly-sovacool

Copy link
Copy Markdown
Member Author

@copilot review the new python coding instructions, then edit all of the python files in this repo to adhere to them.

Copilot AI commented Jun 10, 2026

Copy link
Copy Markdown
Contributor

@copilot review the new python coding instructions, then edit all of the python files in this repo to adhere to them.

Addressed in b59d9b5.

Copilot AI changed the title chore: add python instructions refactor: apply python coding instructions repo-wide Jun 10, 2026
@kelly-sovacool kelly-sovacool merged commit 0e71344 into main Jun 10, 2026
11 checks passed
@kelly-sovacool kelly-sovacool deleted the coding-standards branch June 10, 2026 20:32
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.

2 participants