canton: condense verbose module/choice doc comments#43
Closed
bengtlofgren wants to merge 1 commit into
Closed
Conversation
Comment-only pass across canton/core and canton/test: the module and choice-level doc comments had grown into multi-paragraph essays with ALL-CAPS section labels and repeated restatements of the same point. Tighten them to a sentence or short paragraph per fact, dropping narrative padding while keeping every load-bearing invariant, security rationale, and cross-reference intact (verified: every changed line is either a full comment line or a trailing comment on an otherwise-unchanged code line). Claude-Session: https://claude.ai/code/session_01VFr5RtBKysvjdRN2nKmhMV
3 tasks
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
1 participant
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
canton/coreandcanton/test. Docs had grown into multi-paragraph essays with ALL-CAPS section labels and repeated restatements; this tightens each to a sentence or short paragraph per fact, dropping narrative padding while keeping every load-bearing invariant, security rationale, and cross-reference intact.GetGuardianGovernance, the newguardianGovernancefields -- only exist once canton: pin guardianGovernance on fee-charging CoreState references #41 lands). Rebase ontointegration/cantononce canton: pin guardianGovernance on fee-charging CoreState references #41 merges.Judgment calls worth a second look
GetGuardianGovernance's doc comment, dropped the incidental "...and an attacker guardian set" clause describing a forged CoreState -- the security point (gg is unforgeable) is preserved, just flagging the specific phrasing changed.CoreState's trailing field comments as fair game to tighten, not just the leading-- |block docs -- if you'd rather those stay verbatim, easy to revert just those hunks.Governance.daml,VAA.daml,GuardianSet.daml, and README §10/§4.6 untouched -- already tight or judged too load-bearing/fact-dense to compress further without risk.Test plan
git difffiltered for non-comment changes: none found)dpm buildclean on both packagesdpm test: 44/44 passinghttps://claude.ai/code/session_01VFr5RtBKysvjdRN2nKmhMV