go-pkgz / auth / 26201327753

85%

master: 85%

Build Type

Pull #292

github

Committed by paskal

Commit Message

docs: package-wide comment sweep

Audit prompted by review feedback on PR #290's docstrings — the security PR
landed several long, rationale-heavy doc comments and a couple of them turned
out factually wrong. A combined Codex + Explore-agent sweep over the rest of
the v1 package surfaced ~20 more drift items in pre-existing comments. This
commit fixes both classes in one pass and trims the rationale prose from the
security-fix docs down to API-contract sized statements.

Net 28 files changed across v1 and v2; the line count drops by ~30 because
most of the change is shortening, not adding. Build green, lint clean, go fix
clean on both modules.

Drift fixes (pre-existing wrong/misleading comments):

  * avatar/gridfs.go — ID doc claimed MD5 sourced from gridfs; in reality
    metadata.hash is the sha1 written at Put time.
  * avatar/bolt.go, avatar/gridfs.go — Put docs and BoltDB type doc claimed
    these layers "resize" the image; they only copy bytes verbatim, resize
    happens in Proxy.resize upstream.
  * avatar/store.go — Migrate doc didn't mention that per-avatar Get/Put/Close
    errors are logged and skipped, and that the returned count is "ids
    attempted", not "ids stored".
  * provider/oauth1.go — initOauth1Handler doc and DEBUG log both said
    "oauth2"; the function and the protocol are OAuth 1.
  * provider/service.go — Handler doc said it "returns auth routes"; it
    dispatches login/callback/logout.
  * provider/telegram.go — processUpdates claimed to return an offset (no
    return value); checkToken doc described an "address or empty string"
    return shape but the signature is (*token.User, error).
  * provider/verify.go — Sender interface doc locked the contract to "send
    emails", contradicting the broader "email, IM, or anything else"
    promise on VerifyHandler at line 23. AuthHandler comment was copy-pasted
    from the direct provider.
  * provider/dev_provider.go — NewDev doc said "for admin user"; it makes
    the d... (continued)

Pull Request Pull Request #292: docs: package-wide comment sweep

Coverage Stats

3 of 3 new or added lines in 3 files covered. (100.0%)

28 existing lines in 1 file now uncovered.

3017 of 3533 relevant lines covered (85.39%)

8.2 hits per line