Repository navigation
chore(repo): normalise casing and trim comments - #148
Merged
Merged
Conversation
Runs `terse` over the module: long <summary> blocks cut to three lines with a pointer to Docs/known_issues, <para> and comment essays removed, box-drawing banners deleted, em dashes and arrows replaced with ASCII. The Cyrillic in OpcTreeManagerFB attributes and pin defaults stays: it is the operator-facing UI in the MasterSCADA property grid.
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.
Summary
Two housekeeping changes that belong to no feature branch.
chore(repo): normalise path casingmoves two completed plans fromdocs/toDocs/and fixes theCOMDeviceSDKhint path inNtoLib.csprojfrom..\resources\to..\Resources\, so the paths match the filesystem on a case-sensitive host.style(opctreemanager): trim comments to the terse gaterunsterseover the module. It reported 102 findings before, 21 after.Type of change
What the comment pass changed
<summary>blocks cut to three lines, with a pointer toDocs/known_issues/11-opc-pinpout-sibling-and-iconnect-connect.mdor05-opc-command-pin-connect-overload.mdwhere the detail now lives<para>blocks and 3 four-line comment essays inLinkCollectorTestsremovedApplyDesiredSpecTests"CMD.Результат"in one test fixture became"CMD.Result"; nothing asserts on itThe 21 remaining findings are all in
OpcTreeManagerFB.cs: Cyrillic inside[DisplayName],[Category],[Description]and the pin defaults. That is the operator-facing UI in the MasterSCADA property grid and cannot be ASCII. Beforeterseis wired into the build it needs either a rule that skips string literals and attribute arguments, or a per-file exclusion.terseis not added to the repository in this PR; it was run manually.Testing
dotnet build NtoLib.sln— 0 errors, 0 warningsdotnet test NtoLib.sln— 373 passeddotnet format NtoLib.sln --verify-no-changes— exit 0