Skip to content

fix: missing documenation addition and inaccuracies fix - #13

Merged
danieleTrimarchi merged 1 commit into
devfrom
fix/documentation-inaccuracies
Sep 7, 2026
Merged

danieleTrimarchi merged 1 commit into
devfrom
fix/documentation-inaccuracies

Conversation

@simoncampredon-lang

Copy link
Copy Markdown
Collaborator

Documentation PR for fixing inaccuracies in the comments and the doc, seen with @anatolejimenez.

New documentation for missing classes, fixing the mismatch between the scan_format.rst file and the API reference.

@danieleTrimarchi
danieleTrimarchi merged commit a52c0d6 into dev Sep 7, 2026
9 checks passed
@danieleTrimarchi
danieleTrimarchi deleted the fix/documentation-inaccuracies branch September 7, 2026 14:04
Comment thread docs/raw_format.rst

flatAngles : np.ndarray
Angles of the probe during the acquisition
Angles of the probe during the acquisition, in degrees

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Plane wave angles, in degrees
(The probe doesn't move.)

Comment thread docs/roi_format.rst
Normalized (R, G, B) vector with three components in the range 0..1.

vertices : np.ndarray
(N, 3) array: each row containing the (x, y, z) coordinates of the vertex

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

each row containing the (x, y, z) coordinates of the vertex in the brain space

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

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants