Skip to content

chore(repo): normalise casing and trim comments - #148

Merged
mrcsin merged 2 commits into
masterfrom
opctreemanager-housekeeping
Sep 22, 2026
Merged

mrcsin merged 2 commits into
masterfrom
opctreemanager-housekeeping

Conversation

@mrcsin

@mrcsin mrcsin commented Sep 22, 2026

Copy link
Copy Markdown
Member

Summary

Two housekeeping changes that belong to no feature branch.

chore(repo): normalise path casing moves two completed plans from docs/ to Docs/ and fixes the COMDeviceSDK hint path in NtoLib.csproj from ..\resources\ to ..\Resources\, so the paths match the filesystem on a case-sensitive host.

style(opctreemanager): trim comments to the terse gate runs terse over the module. It reported 102 findings before, 21 after.

Type of change

  • chore — tooling, build, docs, infrastructure

What the comment pass changed

  • 17 <summary> blocks cut to three lines, with a pointer to Docs/known_issues/11-opc-pinpout-sibling-and-iconnect-connect.md or 05-opc-command-pin-connect-overload.md where the detail now lives
  • 5 <para> blocks and 3 four-line comment essays in LinkCollectorTests removed
  • 16 box-drawing banner rules deleted from ApplyDesiredSpecTests
  • 35 em dashes and the arrow characters replaced with ASCII
  • "CMD.Результат" in one test fixture became "CMD.Result"; nothing asserts on it

The 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. Before terse is wired into the build it needs either a rule that skips string literals and attribute arguments, or a per-file exclusion.

terse is not added to the repository in this PR; it was run manually.

Testing

  • dotnet build NtoLib.sln — 0 errors, 0 warnings
  • dotnet test NtoLib.sln — 373 passed
  • dotnet format NtoLib.sln --verify-no-changes — exit 0

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.
@mrcsin
mrcsin merged commit 6bfce48 into master Sep 22, 2026
1 check passed
@mrcsin
mrcsin deleted the opctreemanager-housekeeping branch September 22, 2026 15:42
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