docs: fix package doc comments to say 'Package emulator' after reorg#327
Merged
Conversation
The emulator/ reorg (#310) renamed the package clause substrate -> emulator but left five files' leading doc comments saying 'Package substrate' / 'Package substrate_test', which Go convention flags as a name mismatch. Update the comment lines (doc.go, doc_plugins.go, sns_types.go, coverage_test.go, v030_coverage_test.go); 'Substrate' as the product name in prose is unchanged. Doc-comment only; no code or behaviour change.
Codecov Report✅ All modified and coverable lines are covered by tests. 📢 Thoughts on this report? Let us know! |
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.
Loose end from the
emulator/reorg (#310): the package clause was renamedsubstrate→emulator, but five files' leading doc comments still said// Package substrate/// Package substrate_test— a name mismatch Go/gopls flags.Updates the comment lines in
doc.go,doc_plugins.go,sns_types.go,coverage_test.go,v030_coverage_test.go. 'Substrate' as the product name in prose is left as-is. Doc-comment only — no code or behaviour change; build/vet/lint clean. No CHANGELOG entry (no user-facing effect).