chore: remove spec cross-references from code comments#4
Merged
Conversation
The spec lives in a private, gitignored doc, so code comments that pointed at
spec/section/phase numbers ("spec Section 8.4", "Phase 4 rebalancer", etc.)
referenced something a public reader cannot see. Strip every such reference
from src and test comments, keeping the technical substance of each comment so
it stands on its own (e.g. "behind the Phase 5 timelock" becomes "behind the
methodology-admin timelock"). Comment-only change; no behavior change.
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.
What
The technical spec lives in a private, gitignored document, so code comments that cited spec, section, or phase numbers (
spec Section 8.4,Phase 4 rebalancer,Layer 1 of the supply oracle (spec Section 8.1), and similar) pointed at something a public reader of this repo cannot see.This strips every such reference from
srcandtestcomments, keeping the technical substance of each comment so it reads standalone. For example, "sits behind the Phase 5 timelock" becomes "sits behind the methodology-admin timelock," and the capping comment now describes standard index methodology rather than pointing at a spec section.Scope
Comment-only change across 11 files (
ComponentRegistry,IndexVault,ISupplyOracle,WeightMath,MarketCapMethodology,ExcludedAddressRegistry,SupplyOracle, and four test files). No behavior change, no logic touched. The build compiles and the full suite passes unchanged.