Example · API reference

Source-level API inspection

This is a fully synthetic documentation exercise. It shows how to verify a public interface and locate its surrounding documentation. It does not determine whether any method is scientifically appropriate for a real study.

1. Inspect GazeStudy

Open the direct symbol route:

Open GazeStudy

The enhanced symbol card exposes the currently installed class signature, structured parameter contract, return annotation, source module, source line, docstring summary, minimal call shape, and import:

from gazeaudit import GazeStudy

The pathway backlink places the class inside Structural QC. Follow the linked data-onboarding guide or study-preflight example when the question changes from “what is the constructor contract?” to “how should I map my table?”

2. Inspect run_specs

Open:

Open run_specs

Expand Parameters & minimal call to verify which arguments are required, which are keyword-only, the inspected annotations/defaults, the return annotation, and the mechanically generated call shape. Then use View source when you need implementation-level confirmation.

For example, the current source-level contract is relevant when asking whether execution failures are silently converted into a status row. The Evidence vocabulary explains the audited interpretation boundary; the source link lets you verify the implementation directly.

A minimal local inspection is:

import inspect

from gazeaudit import run_specs

print(inspect.signature(run_specs))
print(inspect.getsourcefile(run_specs))

That is an inspection snippet, not a scientific analysis.

3. Inspect aoi_probabilities

Open:

Open aoi_probabilities

The symbol is linked to the AOI measurement uncertainty pathway. From the same surface you can reach:

• the exact generated signature and source;
• the AOI uncertainty guide;
• the boundary example;
• the AOI probability-profile visual;
• the Korthals evidence boundary.

The Korthals link supplies protocol-bound context. It does not turn the function into a universally validated estimator for every AOI design.

4. Search a symbol directly

Open site search with Ctrl/Cmd + K and enter:

run_specs

For non-empty queries, generated public symbols join the documentation search catalog as Reference / API symbol results. Selecting the result opens the exact symbol fragment rather than only the top of the API Pathways page.

The normal empty-query search remains documentation-focused; 36 symbol records are not dumped into the default browse state.

5. Compare website metadata with local introspection

For any governed symbol:

import inspect

from gazeaudit import aoi_probabilities

print(inspect.signature(aoi_probabilities))
print(inspect.getmodule(aoi_probabilities).__name__)
print(inspect.getsourcelines(aoi_probabilities)[1])

The website generator records these same categories into a deterministic JSON artifact. CI regenerates the artifact from the installed package and compares it byte-for-byte with the checked-in reference.

What is safe to infer?

None of those alone establishes that a scientific choice is suitable for a new dataset.

Continue to Generated API call contracts for a focused exercise on required positional arguments, required keyword-only arguments, all-optional signatures, and return annotations. Return to Read the source-level API reference for the general rules.