Skip to content

docs: api_reference.md run_corners() return type CornerSweepResult is undocumented #118

@github-actions

Description

@github-actions

Problem

docs/api_reference.md documents run_corners() (around line 148) but only says:

Returns: CornerSweepResult containing results for all corners.

CornerSweepResult is never described anywhere in the file — no field descriptions, no type signatures, no usage example.

What the code shows

vajax/analysis/corners.py defines:

class CornerSweepResult:
    corners: list  # list of corner dicts
    results: list  # list of TransientResult

Users have no way to access the results without reading source code. At minimum the fields and their types should be documented, similar to how TransientResult is documented.

Note: Issue #109 covers the missing run_dc_sweep() and DCSweepResult — this is a separate gap for CornerSweepResult.

Metadata

Metadata

Assignees

No one assigned

    Labels

    docsDocumentation issues

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions