docs(comments): strip internal task/milestone/bundle bookkeeping from code comments
Remove project bookkeeping citations from shipped code comments across the solution: hyphenated task IDs (WP-14, StoreAndForward-025), milestone/task/ issue refs (M3, Task 4, Audit Log #23, #21), Bundle X task-bundle labels, and C/D/K/S/T phase labels. Comment text only — no code logic, string/log literals, or XML-doc structure changed. Genuine descriptions are preserved (only the citation is stripped), and technical lookalikes are retained (UTF-8, SHA-256, T00:00:00, M365, UTC-5, pre-C4/pre-C5 schema versions). Flagged by the new CommentChecker TaskReferenceInComment / TrackingReferenceInComment checks plus targeted grep passes; full solution builds clean, append-only guard tests pass.
This commit is contained in:
@@ -21,7 +21,7 @@ namespace ZB.MOM.WW.ScadaBridge.Transport.Import;
|
||||
/// "Coarse" means: each persistent field is compared as a value; differing
|
||||
/// non-code fields appear in <c>changes</c> with old/new values. Code / large-
|
||||
/// text fields (script bodies, API-method scripts) instead carry a structured
|
||||
/// per-line Myers diff (T20): the <see cref="FieldChange.OldValue"/> /
|
||||
/// per-line Myers diff: the <see cref="FieldChange.OldValue"/> /
|
||||
/// <see cref="FieldChange.NewValue"/> keep a compact <c><N lines></c>
|
||||
/// summary for fallback rendering, and a <see cref="FieldChange.LineDiff"/>
|
||||
/// payload carries the hunk lines (+/-/context) plus add/remove totals and a
|
||||
@@ -210,7 +210,7 @@ public sealed class ArtifactDiff
|
||||
incoming.Recipients,
|
||||
e => e.Name,
|
||||
i => i.Name,
|
||||
// S10: a recipient is unchanged only when BOTH contacts match — a phone
|
||||
// A recipient is unchanged only when BOTH contacts match — a phone
|
||||
// number added/changed on an existing recipient is a real diff.
|
||||
(e, i) => e.EmailAddress == i.EmailAddress && e.PhoneNumber == i.PhoneNumber,
|
||||
"Recipients",
|
||||
@@ -254,7 +254,7 @@ public sealed class ArtifactDiff
|
||||
|
||||
/// <summary>
|
||||
/// Compares an incoming SMS provider configuration against the existing one in
|
||||
/// the database (S10b). Mirrors <see cref="CompareSmtpConfiguration"/>: keyed by
|
||||
/// the database. Mirrors <see cref="CompareSmtpConfiguration"/>: keyed by
|
||||
/// the natural key <c>AccountSid</c>, with the auth token diffed presence-only
|
||||
/// (it lives in <see cref="SecretsBlock"/>, never compared by value).
|
||||
/// </summary>
|
||||
@@ -286,7 +286,7 @@ public sealed class ArtifactDiff
|
||||
return BuildItem("SmsConfiguration", incoming.AccountSid, changes);
|
||||
}
|
||||
|
||||
// CompareApiKey was removed in re-arch C4: inbound API keys are not transported
|
||||
// CompareApiKey was removed: inbound API keys are not transported
|
||||
// between environments, so the import preview never diffs keys.
|
||||
|
||||
/// <summary>
|
||||
@@ -301,7 +301,7 @@ public sealed class ArtifactDiff
|
||||
if (existing is null) return New("ApiMethod", incoming.Name);
|
||||
|
||||
var changes = new List<FieldChange>();
|
||||
// ApprovedApiKeyIds is not transported (re-arch C4) and is excluded from the diff.
|
||||
// ApprovedApiKeyIds is not transported and is excluded from the diff.
|
||||
AddIfDifferent(changes, "ParameterDefinitions", existing.ParameterDefinitions, incoming.ParameterDefinitions);
|
||||
AddIfDifferent(changes, "ReturnDefinition", existing.ReturnDefinition, incoming.ReturnDefinition);
|
||||
AddIfDifferent(changes, "TimeoutSeconds", existing.TimeoutSeconds, incoming.TimeoutSeconds);
|
||||
@@ -329,7 +329,7 @@ public sealed class ArtifactDiff
|
||||
return BuildItem("TemplateFolder", incoming.Name, changes);
|
||||
}
|
||||
|
||||
// ---- Site / Connection / Instance (M8) ----
|
||||
// ---- Site / Connection / Instance ----
|
||||
|
||||
/// <summary>
|
||||
/// Compares an incoming site against the existing site in the database.
|
||||
@@ -504,8 +504,8 @@ public sealed class ArtifactDiff
|
||||
|
||||
private static void AddCodeChangeIfDifferent(List<FieldChange> changes, string field, string? existing, string? incoming)
|
||||
{
|
||||
// Code/large-text fields: when they differ, emit a real per-line Myers diff
|
||||
// (T20). The OldValue/NewValue keep a compact "<N lines>" summary as a
|
||||
// Code/large-text fields: when they differ, emit a real per-line Myers diff.
|
||||
// The OldValue/NewValue keep a compact "<N lines>" summary as a
|
||||
// fallback for renderers that don't consume the structured payload; the
|
||||
// LineDiff carries the +/- hunk lines. Identical code emits no change.
|
||||
var sameNullness = existing is null == incoming is null;
|
||||
@@ -635,7 +635,7 @@ public sealed class ArtifactDiff
|
||||
if (!ScriptsEqual(ex, inc))
|
||||
{
|
||||
// A script row can diverge in Code and/or its trigger/param metadata.
|
||||
// The structured line diff covers the Code body (T20); when only the
|
||||
// The structured line diff covers the Code body; when only the
|
||||
// metadata changed the hunk list is all-context (no +/-), which still
|
||||
// tells the operator the row changed.
|
||||
changes.Add(BuildCodeFieldChange($"Scripts.{name}", ex.Code, inc.Code));
|
||||
@@ -696,7 +696,7 @@ public sealed class ArtifactDiff
|
||||
[property: JsonPropertyName("field")] string Field,
|
||||
[property: JsonPropertyName("oldValue")] string? OldValue,
|
||||
[property: JsonPropertyName("newValue")] string? NewValue,
|
||||
// Present only for code / large-text fields (T20). Null (and omitted from
|
||||
// Present only for code / large-text fields. Null (and omitted from
|
||||
// the JSON by the WhenWritingNull policy) for ordinary coarse fields.
|
||||
[property: JsonPropertyName("lineDiff")] LineDiffPayload? LineDiff = null);
|
||||
|
||||
|
||||
Reference in New Issue
Block a user