Fix LButtJoint modify_cross - #490
Merged
Merged
Conversation
Contributor
There was a problem hiding this comment.
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_crossfromFalsetoTrueinLButtJoint.__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 ofmodify_cross=Trueso 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_crossdefaults toTruewhen instantiatingLButtJointto 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 ReportAll modified and coverable lines are covered by tests ✅
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. 🚀 New features to boost your workflow:
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
LButtJoint.__init__()had the wrong default value formodify_cross.What type of change is this?
Checklist
Put an
xin 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.CHANGELOG.mdfile in theUnreleasedsection under the most fitting heading (e.g.Added,Changed,Removed).invoke test).invoke lint).compas_timber.datastructures.Beam.