Skip to content

docs: api_reference.md run_corners() signature missing the 'analysis' parameter #126

@github-actions

Description

@github-actions

Problem

api_reference.md documents run_corners() with an incomplete signature — the analysis parameter is not shown.

The documented signature appears as just engine.run_corners(corners).

Reality

The actual signature is:

run_corners(corners, analysis='transient', **prepare_kwargs) -> CornerSweepResult

The analysis parameter controls which analysis type runs for each corner (transient, dc, ac). Without documenting this parameter, users have no way to know how to run DC or AC corner sweeps.

Note: #118 tracks the missing CornerSweepResult return type documentation; this is a separate issue about the missing input parameter.

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