Skip to content

[DRK-133] Split AuditLogAttribute XML doc: move property-level behaviour into remarks - #335

Merged
baoduy merged 1 commit into
devfrom
feature/drk-133-auditlog-doc-split
Aug 5, 2026
Merged

[DRK-133] Split AuditLogAttribute XML doc: move property-level behaviour into remarks#335
baoduy merged 1 commit into
devfrom
feature/drk-133-auditlog-doc-split

Conversation

@baoduy

@baoduy baoduy commented Aug 5, 2026

Copy link
Copy Markdown
Owner

Doc-only change: split AuditLogAttribute's XML doc so the class-level and property-level meanings each get their own audience.

  • <summary> now covers only the class-level meaning (entity inclusion in the audit log).
  • The property-level meaning (force-plaintext under RedactSensitive, allow-listing under OnlyAttributedProperties) moved into a separate <remarks> block.

No behavioural, API-surface, or public-signature change. dotnet build -c Debug verified warning-free.

Class-level meaning stays in <summary>; the property-level, policy-
dependent meaning moves to a separate <remarks> section.

Co-authored-by: multica-agent <github@multica.ai>
@github-actions

github-actions Bot commented Aug 5, 2026

Copy link
Copy Markdown

📊 Code Coverage Report

| Metric | Coverage |
|--------|----------|
| **Line Coverage** | 81.9% |
| **Branch Coverage** | 80.1% |
| **Method Coverage** | 84.1% |

**Lines:** 3405/undefined covered
**Branches:** 1275/undefined covered

📈 [View Full Coverage Report](https://github.com/baoduy/DKNet/actions/runs/30964282316)

@codecov

codecov Bot commented Aug 5, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 78.65%. Comparing base (dc4d57e) to head (7f342fd).

Additional details and impacted files
@@           Coverage Diff           @@
##              dev     #335   +/-   ##
=======================================
  Coverage   78.65%   78.65%           
=======================================
  Files         169      169           
  Lines        4155     4155           
  Branches      609      609           
=======================================
  Hits         3268     3268           
  Misses        703      703           
  Partials      184      184           
Flag Coverage Δ
unittests 78.65% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Harness.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@baoduy

baoduy commented Aug 5, 2026

Copy link
Copy Markdown
Owner Author

PR Review: #335 — Split AuditLogAttribute XML doc

Verdict: APPROVED — docs-only change, spec-perfect, all preconditions pass.

Findings

Severity File:Line Finding
praise AuditLogAttribute.cs:9-16 The <remarks> block is the correct XML doc element for supplementary detail — it renders in IDE hover tooltips alongside <summary>, giving each audience the right first sentence. Exactly matches the cycle spec.

Score

Category Score Weight Notes
Correctness & logic 10 25% No logic changed
Security 10 20% No security surface
Testing & coverage 10 20% Docs-only, vacuously satisfied
Maintainability & design 10 15% Clean split, correct XML doc element choice
Spec conformance 10 10% Exact match to DRK-133 spec
Style & conventions 10 5% Matches existing indentation, well-formed XML
AI-slop gate 10 5% No slop patterns
Weighted 10.0 Docs-only floor 9.0 — not reached (score exceeds it)

Score: 10.0 / 10

Auto-merge preconditions

Condition Status
No blocking/critical findings
No secrets
CI green ✓ (6/6 passed)
No protected paths
Not draft, base is dev
Coverage on changed lines ✓ (docs-only, vacuously satisfied)
No external-source changes

@baoduy
baoduy merged commit 443e845 into dev Aug 5, 2026
6 checks passed
@baoduy
baoduy deleted the feature/drk-133-auditlog-doc-split branch August 5, 2026 00:49
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