Code-compliance & Documentation-Compliance fixes#3576
Conversation
michaelhoehn
requested review from
FraserGreenroyd,
IsakNaslundBh,
adecler,
al-fisher,
jamesramsden-bh,
peterjamesnugent,
rwemay and
tg359
as code owners
michaelhoehn
requested review from
sakanni
and removed request for
FraserGreenroyd,
IsakNaslundBh,
jamesramsden-bh,
rwemay and
tg359
|
@BHoMBot check compliance |
|
@michaelhoehn to confirm, the following actions are now queued:
There are 1658 requests in the queue ahead of you. |
|
@BHoMBot check compliance |
|
@michaelhoehn to confirm, the following actions are now queued:
There are 1665 requests in the queue ahead of you. |
|
@BHoMBot check installer |
|
@michaelhoehn to confirm, the following actions are now queued:
There are 1646 requests in the queue ahead of you. |
|
@BHoMBot check required |
|
@michaelhoehn to confirm, the following actions are now queued:
There are 1648 requests in the queue ahead of you. |
|
Please be advised that the check with reference 68627551650 has more than 50 annotations of notes. API limitations restrict annotations to 50. You may need to rerun this check to obtain the next set when you make changes. At the time of reporting this check, there are 27 additional annotations waiting, made up of 27 errors and 0 warnings. |
|
The check |
|
The check |
|
Please be advised that the check with reference 68632325990 has more than 50 annotations of notes. API limitations restrict annotations to 50. You may need to rerun this check to obtain the next set when you make changes. At the time of reporting this check, there are 27 additional annotations waiting, made up of 27 errors and 0 warnings. |
|
Please be advised that the check with reference 71764110279 has more than 50 annotations of notes. API limitations restrict annotations to 50. You may need to rerun this check to obtain the next set when you make changes. At the time of reporting this check, there are 27 additional annotations waiting, made up of 27 errors and 0 warnings. |
|
Please be advised that the check with reference 71927932497 has more than 50 annotations of notes. API limitations restrict annotations to 50. You may need to rerun this check to obtain the next set when you make changes. At the time of reporting this check, there are 27 additional annotations waiting, made up of 27 errors and 0 warnings. |
|
Please be advised that the check with reference 71989975942 has more than 50 annotations of notes. API limitations restrict annotations to 50. You may need to rerun this check to obtain the next set when you make changes. At the time of reporting this check, there are 27 additional annotations waiting, made up of 27 errors and 0 warnings. |
|
Please be advised that the check with reference 72063426696 has more than 50 annotations of notes. API limitations restrict annotations to 50. You may need to rerun this check to obtain the next set when you make changes. At the time of reporting this check, there are 27 additional annotations waiting, made up of 27 errors and 0 warnings. |
|
Please be advised that the check with reference 72351210774 has more than 50 annotations of notes. API limitations restrict annotations to 50. You may need to rerun this check to obtain the next set when you make changes. At the time of reporting this check, there are 27 additional annotations waiting, made up of 27 errors and 0 warnings. |
|
Please be advised that the check with reference 72622876350 has more than 50 annotations of notes. API limitations restrict annotations to 50. You may need to rerun this check to obtain the next set when you make changes. At the time of reporting this check, there are 27 additional annotations waiting, made up of 27 errors and 0 warnings. |
|
Please be advised that the check with reference 72818277483 has more than 50 annotations of notes. API limitations restrict annotations to 50. You may need to rerun this check to obtain the next set when you make changes. At the time of reporting this check, there are 29 additional annotations waiting, made up of 29 errors and 0 warnings. |
|
Please be advised that the check with reference 72987070608 has more than 50 annotations of notes. API limitations restrict annotations to 50. You may need to rerun this check to obtain the next set when you make changes. At the time of reporting this check, there are 29 additional annotations waiting, made up of 29 errors and 0 warnings. |
|
Please be advised that the check with reference 73329644600 has more than 50 annotations of notes. API limitations restrict annotations to 50. You may need to rerun this check to obtain the next set when you make changes. At the time of reporting this check, there are 27 additional annotations waiting, made up of 27 errors and 0 warnings. |
|
Please be advised that the check with reference 73515039866 has more than 50 annotations of notes. API limitations restrict annotations to 50. You may need to rerun this check to obtain the next set when you make changes. At the time of reporting this check, there are 27 additional annotations waiting, made up of 27 errors and 0 warnings. |
|
Please be advised that the check with reference 73717581850 has more than 50 annotations of notes. API limitations restrict annotations to 50. You may need to rerun this check to obtain the next set when you make changes. At the time of reporting this check, there are 27 additional annotations waiting, made up of 27 errors and 0 warnings. |
|
Please be advised that the check with reference 73893933145 has more than 50 annotations of notes. API limitations restrict annotations to 50. You may need to rerun this check to obtain the next set when you make changes. At the time of reporting this check, there are 27 additional annotations waiting, made up of 27 errors and 0 warnings. |
|
Please be advised that the check with reference 74023712741 has more than 50 annotations of notes. API limitations restrict annotations to 50. You may need to rerun this check to obtain the next set when you make changes. At the time of reporting this check, there are 27 additional annotations waiting, made up of 27 errors and 0 warnings. |
|
Please be advised that the check with reference 74089238266 has more than 50 annotations of notes. API limitations restrict annotations to 50. You may need to rerun this check to obtain the next set when you make changes. At the time of reporting this check, there are 27 additional annotations waiting, made up of 27 errors and 0 warnings. |
|
Please be advised that the check with reference 74169846400 has more than 50 annotations of notes. API limitations restrict annotations to 50. You may need to rerun this check to obtain the next set when you make changes. At the time of reporting this check, there are 27 additional annotations waiting, made up of 27 errors and 0 warnings. |
|
Please be advised that the check with reference 74352899574 has more than 50 annotations of notes. API limitations restrict annotations to 50. You may need to rerun this check to obtain the next set when you make changes. At the time of reporting this check, there are 27 additional annotations waiting, made up of 27 errors and 0 warnings. |
|
Please be advised that the check with reference 74547126061 has more than 50 annotations of notes. API limitations restrict annotations to 50. You may need to rerun this check to obtain the next set when you make changes. At the time of reporting this check, there are 27 additional annotations waiting, made up of 27 errors and 0 warnings. |
|
Please be advised that the check with reference 74752190530 has more than 50 annotations of notes. API limitations restrict annotations to 50. You may need to rerun this check to obtain the next set when you make changes. At the time of reporting this check, there are 27 additional annotations waiting, made up of 27 errors and 0 warnings. |
|
Please be advised that the check with reference 74952015286 has more than 50 annotations of notes. API limitations restrict annotations to 50. You may need to rerun this check to obtain the next set when you make changes. At the time of reporting this check, there are 27 additional annotations waiting, made up of 27 errors and 0 warnings. |
|
Please be advised that the check with reference 75129426801 has more than 50 annotations of notes. API limitations restrict annotations to 50. You may need to rerun this check to obtain the next set when you make changes. At the time of reporting this check, there are 27 additional annotations waiting, made up of 27 errors and 0 warnings. |
|
Please be advised that the check with reference 75203216059 has more than 50 annotations of notes. API limitations restrict annotations to 50. You may need to rerun this check to obtain the next set when you make changes. At the time of reporting this check, there are 27 additional annotations waiting, made up of 27 errors and 0 warnings. |
|
Please be advised that the check with reference 75285489568 has more than 50 annotations of notes. API limitations restrict annotations to 50. You may need to rerun this check to obtain the next set when you make changes. At the time of reporting this check, there are 27 additional annotations waiting, made up of 27 errors and 0 warnings. |
|
Please be advised that the check with reference 75496109170 has more than 50 annotations of notes. API limitations restrict annotations to 50. You may need to rerun this check to obtain the next set when you make changes. At the time of reporting this check, there are 27 additional annotations waiting, made up of 27 errors and 0 warnings. |
|
Please be advised that the check with reference 75713437562 has more than 50 annotations of notes. API limitations restrict annotations to 50. You may need to rerun this check to obtain the next set when you make changes. At the time of reporting this check, there are 27 additional annotations waiting, made up of 27 errors and 0 warnings. |
|
Please be advised that the check with reference 75926434354 has more than 50 annotations of notes. API limitations restrict annotations to 50. You may need to rerun this check to obtain the next set when you make changes. At the time of reporting this check, there are 27 additional annotations waiting, made up of 27 errors and 0 warnings. |
|
Please be advised that the check with reference 76120698562 has more than 50 annotations of notes. API limitations restrict annotations to 50. You may need to rerun this check to obtain the next set when you make changes. At the time of reporting this check, there are 27 additional annotations waiting, made up of 27 errors and 0 warnings. |
|
Please be advised that the check with reference 76292533947 has more than 50 annotations of notes. API limitations restrict annotations to 50. You may need to rerun this check to obtain the next set when you make changes. At the time of reporting this check, there are 27 additional annotations waiting, made up of 27 errors and 0 warnings. |
|
Please be advised that the check with reference 76369390307 has more than 50 annotations of notes. API limitations restrict annotations to 50. You may need to rerun this check to obtain the next set when you make changes. At the time of reporting this check, there are 27 additional annotations waiting, made up of 27 errors and 0 warnings. |
|
Please be advised that the check with reference 76457097234 has more than 50 annotations of notes. API limitations restrict annotations to 50. You may need to rerun this check to obtain the next set when you make changes. At the time of reporting this check, there are 27 additional annotations waiting, made up of 27 errors and 0 warnings. |
|
Please be advised that the check with reference 76665713369 has more than 50 annotations of notes. API limitations restrict annotations to 50. You may need to rerun this check to obtain the next set when you make changes. At the time of reporting this check, there are 27 additional annotations waiting, made up of 27 errors and 0 warnings. |
1 participant
NOTE: Depends on
Issues addressed by this PR
Closes #3575
Resolves all MethodNameContainsFileName and ModifyReturnsDifferentType compliance
failures across BHoM_Engine.
Method renames:
ExternalPolyCurveExternalPolycurveStartSuppressRecordingEventsStartSuppressRecordingStopSuppressRecordingEventsStopSuppressRecordingRemoveAndSplitAtIndexesSplitAndRemoveAtIndexesFurthestTightSquareDistanceFurthestSquareDistanceMaptoLevelMapToLevelReplaceConnectedSpaceNameReplaceSpaceNameDependencyChartViewDependencyChartMatchScoreFuzzyMatchVisibility change:
Graphics_Engine/Modify/RepresentationFragments/Boxes.cs-RepresentationFragmentchanged
publictoprivate, consistent withLinks.cs. UI access preserved viathe public
IRepresentationFragmentdispatcher.Signature change:
Environment_Engine/Modify/ReplaceSpaceName.cs- first parameter widened fromList<Panel>toIEnumerable<Panel>. Return type remainsList<Panel>,satisfying ModifyReturnsDifferentType. All existing call sites remain valid.
Internal caller updates:
Data_Engine/Query/ClosestData.cs- updated call fromFurthestTightSquareDistanceto
FurthestSquareDistance. All other renames verified to have no additionalinternal callers.
Test files
Changelog
Data_Engine, Environment_Engine, Graphics_Engine, and Search_Engine
ReplaceSpaceNamefirst parameter widened toIEnumerable<Panel>Description,Input, andOutputattributes to thePointMatrix<T>overload ofClosestDatain Data_EngineAdditional comments
The
Boxes.csvisibility change warrants note for reviewers: the method is aninternal dispatch target for the
IRepresentationFragmentpattern and was neverintended to be a direct public API entry point. Making it private aligns it with
Links.cs, which has always used this same pattern correctly.Note
Medium Risk
Mostly mechanical renames, but they change public API surface (method names, one signature/return behavior, and one method visibility) which may break external callers not updated in this repo.
Overview
Primarily API/compliance cleanup: multiple engine methods are renamed to match file naming conventions (e.g.
ExternalPolycurve,Start/StopSuppressRecording,SplitAndRemoveAtIndexes,FurthestSquareDistanceTight,MapToLevel,ReplaceSpaceName,DependencyChart,FuzzyMatch), with corresponding internal call updates.A few targeted behavior/signature adjustments accompany the renames:
ReplaceSpaceNamenow acceptsIEnumerable<Panel>and returnsnullwhen input isnull(and materializes toListon early-exit error),Boxes.RepresentationFragmentis madeprivate(intended to be accessed via the dispatcher), andPointMatrix<T>.ClosestDatagains missingDescription/Input/Outputattributes.Written by Cursor Bugbot for commit de4236e. This will update automatically on new commits. Configure here.