Skip to content

Add rustdoc comments to src/contracts/logic.rs and proxy_entry.rs #246

Description

@N-thnI

Problem

src/contracts/logic.rs (700 lines) and src/contracts/proxy_entry.rs (917 lines) — the two largest files in the crate, and the core of the contract's public surface and upgrade-proxy logic — have zero /// rustdoc comments between them.

Why it matters

plan.md's "Documentation" section explicitly asks for "Inline rustdoc — add /// doc comments to every public function explaining parameters, errors, and side-effects." These two files are the highest-value, highest-complexity target for that and currently have none, making them the hardest files in the repo for a new contributor to safely modify.

Acceptance criteria

  • Add /// doc comments to every pub fn in src/contracts/logic.rs, covering parameters, return value, error conditions, and any side effects (storage writes, events emitted, auth requirements)
  • Do the same for every pub fn in src/contracts/proxy_entry.rs
  • cargo doc builds cleanly with no warnings about missing docs (if #[warn(missing_docs)] is enabled; otherwise just verify visually)
  • No behavioral changes — comments only

Scope

Doc comments only in the two named files. Do not modify function bodies or signatures.

Definition of done

Every public function in logic.rs and proxy_entry.rs has a rustdoc comment describing its parameters, errors, and side effects; cargo doc --no-deps builds without missing-docs warnings for these two files.

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

Labels

GrantFox OSSIssue tracked in GrantFox OSSMaybe RewardedIssue may be eligible for a GrantFox rewardThird CampaignCampaign: Third CampaigndocumentationImprovements or additions to documentationenhancementNew feature or request

Type

No type

Projects

No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions