Skip to content
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

refactor!: more protobuf cleaning #511

Merged
merged 1 commit into from
Oct 28, 2024
Merged

Conversation

holtgrewe
Copy link
Contributor

@holtgrewe holtgrewe commented Oct 28, 2024

Release-As: 0.16.0

Summary by CodeRabbit

  • New Features

    • Enhanced clarity in frequency settings with renamed fields for maximum counts and frequencies in both Nuclear and Mitochondrial Frequency Settings.
  • Bug Fixes

    • Updated frequency filtering logic to utilize new field names for improved consistency and clarity.
  • Tests

    • Adjusted test cases to reflect the new field names, ensuring accurate assertions in frequency settings.

Copy link
Contributor

coderabbitai bot commented Oct 28, 2024

Caution

Review failed

The pull request is closed.

Walkthrough

The changes in this pull request focus on renaming fields in the NuclearFrequencySettings and MitochondrialFrequencySettings messages across three files: query.proto, frequency.rs, and query.rs. The renaming aims to enhance clarity by changing field names such as heterozygous to max_het, homozygous to max_hom, and frequency to max_af. These changes are reflected in the respective structures, function parameters, and logic for filtering frequency data, while the overall functionality remains unchanged.

Changes

File Path Change Summary
protos/varfish/v1/seqvars/query.proto Renamed fields in NuclearFrequencySettings and MitochondrialFrequencySettings for clarity: heterozygous to max_het, homozygous to max_hom, hemizygous to max_hemi, and frequency to max_af.
src/seqvars/query/interpreter/frequency.rs Updated passes function and related test functions to use renamed fields: max_het, max_hom, and max_af.
src/seqvars/query/schema/query.rs Renamed fields in structs NuclearFrequencySettings and MitochondrialFrequencySettings for clarity: heterozygous to max_het, homozygous to max_hom, and frequency to max_af.

Possibly related PRs

  • feat: add mode of inheritance from HPO #493: The changes in this PR involve renaming fields in the NuclearFrequencySettings and MitochondrialFrequencySettings structs, which directly relate to the renaming of fields in the same messages in the main PR.

🐰 In the meadow where changes bloom,
Fields renamed to lift the gloom.
Max counts now clear, no need to fret,
Clarity shines, a safe bet!
With every hop, we celebrate,
New names bring joy, oh, isn't it great? 🌼


Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ Share
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

@holtgrewe holtgrewe enabled auto-merge (squash) October 28, 2024 07:11
@holtgrewe holtgrewe merged commit 06ebb8a into main Oct 28, 2024
8 of 9 checks passed
@holtgrewe holtgrewe deleted the refactor-more-protobuf-cleaning branch October 28, 2024 07:14
Copy link

codecov bot commented Oct 28, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 71%. Comparing base (0edcf98) to head (28da9b4).
Report is 1 commits behind head on main.

Additional details and impacted files
@@          Coverage Diff          @@
##            main    #511   +/-   ##
=====================================
- Coverage     71%     71%   -1%     
=====================================
  Files         43      43           
  Lines      11834   11831    -3     
=====================================
- Hits        8504    8501    -3     
  Misses      3330    3330           
Files with missing lines Coverage Δ
src/seqvars/query/interpreter/frequency.rs 85% <100%> (-1%) ⬇️
src/seqvars/query/schema/query.rs 96% <100%> (ø)

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