docs: add docstrings across internal packages#143
Conversation
|
Warning Rate limit exceeded
To continue reviewing without waiting, purchase usage credits in the billing tab. ⌛ How to resolve this issue?After the wait time has elapsed, a review can be triggered using the We recommend that you space out your commits to avoid hitting the rate limit. 🚦 How do rate limits work?CodeRabbit enforces hourly rate limits for each developer per organization. Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout. Please see our FAQ for further information. ℹ️ Review info⚙️ Run configurationConfiguration used: defaults Review profile: CHILL Plan: Pro Run ID: 📒 Files selected for processing (10)
✨ Finishing Touches🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
- health_monitor.go: document runChecks, probeRecord, probeHTTP, probeTCP - dns_service.go: document CreateZone, CreateRecord, Resolve, ListZones, ListRecordsForZone, DeleteZone, DeleteRecord, ImportZone, audit, filterHealthy
Document: generateServerCookie, padResponse, automateDNSSEC, startInvalidationListener, handleDoH, udpWorker, handleUDPConnection, handleTCPConnection, handleAXFR, sendTCPError, handlePacket, handleNotify, handleUpdate, handleIXFR, signResponse, groupRecords, sendSingleRecordResponse, sendUpdateResponse, checkPrerequisite, notifySlaves, generateNSEC, generateNSEC3, generateTypeBitMap, queryTypeToRecordType, refreshZone, performIXFR, performAXFR, newRateLimiter, Allow, fnv32, lockKey
Document: newRecursiveResolver, getShuffledRoots, resolveRecursive, generateTransactionID, sendQuery, sendQueryInternal, sendTCPQuery, findNextNS, setReusePort, countLabels
Document: main, run, getEnvUint32 in cmd/clouddns; Run, handleUnsupportedOS in routing
The stash conflict resolution introduced a syntax error (<// comment) and dropped the ctx argument from the probeTCP call in probeRecord. Also fixes test calls that omitted the ctx argument.
poyrazK
force-pushed
the
release/docstrings
branch
from
7c6441f to
a99a8de
Compare
1 participant
Summary
Add docstrings to all non-obvious undocumented functions across internal packages.
Changes
4 commits covering:
internal/core/services/: health_monitor + dns_service docstringsinternal/dns/server/: server handlers, recursive resolver, ratelimit, utilitiesinternal/dns/packet/: countLabels utilitycmd/clouddns+internal/adapters/routing/: main entry point and routing adapterCoverage improvement
Skipped: heap interface methods (Len/Less/Swap/Push/Pop), lock methods (Lock/Unlock), error interface (Error) — self-explanatory boilerplate.
Test plan
go build ./...go test ./... -timeout 60s