docs(octo): refresh package doc and fix stale comment references#29
Merged
Conversation
Comment/doc-only cleanup of the Octo integration (no code change): - doc.go: was badly stale — pointed at the old internal/integrations/im transport path and still said 'implementation lands in later phases'. Rewrote it as an accurate package overview: the one-directional transport->business layering and the role of each moving part (Hub, Dispatcher, Patcher, OutcomeReplier, BindingTokenService, InstallationService) plus the octo_cleanup scheduler job. - types.go: InboundMessage doc referenced internal/integrations/im → internal/integrations/octo/transport. - Grammar: 'an transport.X' → 'a transport.X' in types.go, connector.go, hub.go. Left intentionally: 'im_token' (a real WuKongIM register-response field, not a leftover of the im→transport package rename) and the im.example / im.deepminer URLs in tests.
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.
Comment/doc-only cleanup of the Octo integration — no code change.
What
doc.gowas badly stale: it pointed at the oldinternal/integrations/imtransport path (renamed toocto/transportin refactor(octo): move WuKongIM transport into octo/transport subpackage #13) and still claimed 'implementation lands in later phases (dispatcher, outbound, binding, hub)' — all long since implemented. Rewrote it as an accurate package overview: the one-directionaltransport → businesslayering and the role of each moving part (Hub, Dispatcher, Patcher, OutcomeReplier, BindingTokenService, InstallationService), plus a pointer to theocto_cleanupscheduler job.types.go:InboundMessagedoc referencedinternal/integrations/im→ corrected tointernal/integrations/octo/transport.an transport.X→a transport.Xintypes.go,connector.go,hub.go.Left intentionally
im_token— a real WuKongIM register-response field, not a leftover of theim→transportpackage rename.im.example/im.deepminerURLs in tests.go build+go vetclean (comments only).