Skip to content

Fix LButtJoint modify_cross - #490

Merged
obucklin merged 3 commits into
mainfrom
fix_LButtJoint_modify_cross
Jul 14, 2025
Merged

Fix LButtJoint modify_cross#490
obucklin merged 3 commits into
mainfrom
fix_LButtJoint_modify_cross

Conversation

@obucklin

@obucklin obucklin commented Jul 14, 2025

Copy link
Copy Markdown
Contributor

LButtJoint.__init__() had the wrong default value for modify_cross.

What type of change is this?

  • Bug fix in a backwards-compatible manner.
  • New feature in a backwards-compatible manner.
  • Breaking change: bug fix or new feature that involve incompatible API changes.
  • Other (e.g. doc update, configuration, etc)

Checklist

Put an x in the boxes that apply. You can also fill these out after creating the PR. If you're unsure about any of them, don't hesitate to ask. We're here to help! This is simply a reminder of what we are going to look for before merging your code.

  • I added a line to the CHANGELOG.md file in the Unreleased section under the most fitting heading (e.g. Added, Changed, Removed).
  • I ran all tests on my computer and it's all green (i.e. invoke test).
  • I ran lint on my computer and there are no errors (i.e. invoke lint).
  • I added new functions/classes and made them available on a second-level import, e.g. compas_timber.datastructures.Beam.
  • I have added tests that prove my fix is effective or that my feature works.
  • I have added necessary documentation (if appropriate)

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Pull Request Overview

This PR corrects the default behavior of the modify_cross parameter in the LButtJoint constructor and records the change in the changelog.

  • Changed the default value of modify_cross from False to True in LButtJoint.__init__
  • Added a corresponding entry in CHANGELOG.md

Reviewed Changes

Copilot reviewed 2 out of 2 changed files in this pull request and generated no comments.

File Description
src/compas_timber/connections/l_butt.py Updated modify_cross default to True in the constructor
CHANGELOG.md Added bullet for the modify_cross default change for LButtJoint
Comments suppressed due to low confidence (3)

src/compas_timber/connections/l_butt.py:65

  • Update the docstring for LButtJoint.__init__ (if present) to reflect the new default of modify_cross=True so that the API documentation remains accurate.
    def __init__(self, main_beam=None, cross_beam=None, mill_depth=None, small_beam_butts=False, modify_cross=True, reject_i=False, butt_plane=None, back_plane=None, **kwargs):

CHANGELOG.md:62

  • [nitpick] Indent this new bullet with two spaces before the asterisk to match the existing changelog entry style and maintain consistent formatting.
* Changed default value for `modify_cross` to `True` for `LButtJoint`.

src/compas_timber/connections/l_butt.py:65

  • Add a unit test to verify that modify_cross defaults to True when instantiating LButtJoint to prevent future regressions.
    def __init__(self, main_beam=None, cross_beam=None, mill_depth=None, small_beam_butts=False, modify_cross=True, reject_i=False, butt_plane=None, back_plane=None, **kwargs):

@codecov

codecov Bot commented Jul 14, 2025

Copy link
Copy Markdown

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 64.08%. Comparing base (bb4eb97) to head (f941bdb).
Report is 4 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff             @@
##             main     #490      +/-   ##
==========================================
- Coverage   64.08%   64.08%   -0.01%     
==========================================
  Files          76       76              
  Lines       10877    10877              
==========================================
- Hits         6971     6970       -1     
- Misses       3906     3907       +1     

☔ View full report in Codecov by Sentry.
📢 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.

@chenkasirer chenkasirer left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

LGTM

@obucklin
obucklin merged commit 9f491ba into main Jul 14, 2025
16 of 17 checks passed
@obucklin
obucklin deleted the fix_LButtJoint_modify_cross branch July 14, 2025 15:01
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.

3 participants