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:
@@ -12,7 +12,7 @@ namespace ZB.MOM.WW.ScadaBridge.DeploymentManager;
|
||||
/// Orchestrates the TemplateEngine services (FlatteningService, ValidationService, RevisionHashService)
|
||||
/// into a single pipeline for deployment use.
|
||||
///
|
||||
/// WP-16: This captures template state at the time of flatten, ensuring that concurrent template edits
|
||||
/// This captures template state at the time of flatten, ensuring that concurrent template edits
|
||||
/// (last-write-wins) do not conflict with in-progress deployments.
|
||||
/// </summary>
|
||||
public class FlatteningPipeline : IFlatteningPipeline
|
||||
@@ -31,7 +31,7 @@ public class FlatteningPipeline : IFlatteningPipeline
|
||||
/// <param name="validationService">Service that performs semantic validation on the flattened config.</param>
|
||||
/// <param name="revisionHashService">Service that computes the revision hash for staleness detection.</param>
|
||||
/// <param name="sharedSchemaRepo">
|
||||
/// M9-T32b: repository backing the JSON-Schema <c>$ref</c> resolution seam. Used to
|
||||
/// Repository backing the JSON-Schema <c>$ref</c> resolution seam. Used to
|
||||
/// look up <c>lib:Name</c> library references so a dangling reference in any validated
|
||||
/// script schema becomes a deploy-blocking error.
|
||||
/// </param>
|
||||
@@ -135,7 +135,7 @@ public class FlatteningPipeline : IFlatteningPipeline
|
||||
.Select(c => c.Name)
|
||||
.ToHashSet(StringComparer.Ordinal);
|
||||
|
||||
// M2.8 (#23): the set of data-connection names that actually exist on the
|
||||
// The set of data-connection names that actually exist on the
|
||||
// target site, used to verify each bound connection resolves to a real site
|
||||
// connection. Same StringComparer.Ordinal as the rest of the binding-resolution
|
||||
// path (connection names are matched as-authored throughout the pipeline).
|
||||
@@ -143,7 +143,7 @@ public class FlatteningPipeline : IFlatteningPipeline
|
||||
.Select(c => c.Name)
|
||||
.ToHashSet(StringComparer.Ordinal);
|
||||
|
||||
// M9-T32b: build the JSON-Schema $ref resolution seam from the shared-schema
|
||||
// Build the JSON-Schema $ref resolution seam from the shared-schema
|
||||
// library. The seam ValidationService consumes is synchronous, so the library is
|
||||
// pre-loaded once into a name→JSON map here (avoiding sync-over-async) and the
|
||||
// seam is a pure in-memory lookup. An unresolved {"$ref":"lib:Name"} in any
|
||||
|
||||
Reference in New Issue
Block a user