Skip to content

change doc string#160

Merged
f-brinkmann merged 1 commit intodevelopfrom
bug/early_lateral_energy_fraction_documentation
Mar 18, 2026
Merged

change doc string#160
f-brinkmann merged 1 commit intodevelopfrom
bug/early_lateral_energy_fraction_documentation

Conversation

@artur-pa
Copy link
Contributor

Which issue(s) are closed by this pull request?

Error in the docstring: early_lateral_energy_fraction does not return a value in dB, but rather an energy ratio

  Returns
    -------
    Early Lateral Energy Fraction: numpy.ndarray
        Early lateral energy fraction (:math:`J_\mathrm{LF}`) in decibels,
        shaped according to the channel shape of the input EDCs.

Changes proposed in this pull request:

  Returns
    -------
    Early Lateral Energy Fraction: numpy.ndarray
        Early lateral energy fraction (:math:`J_\mathrm{LF}`),
        shaped according to the channel shape of the input EDCs.

@artur-pa artur-pa added this to the v1.0.0 milestone Mar 18, 2026
@artur-pa artur-pa added the bug Something isn't working label Mar 18, 2026
@artur-pa artur-pa moved this from Backlog to Require review in Weekly Planning Mar 18, 2026
Copy link
Member

@f-brinkmann f-brinkmann left a comment

Choose a reason for hiding this comment

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

Thanks for catching

@github-project-automation github-project-automation bot moved this from Require review to Reviewer Approved in Weekly Planning Mar 18, 2026
@f-brinkmann f-brinkmann merged commit 518ba41 into develop Mar 18, 2026
16 checks passed
@github-project-automation github-project-automation bot moved this from Reviewer Approved to Done in Weekly Planning Mar 18, 2026
@f-brinkmann f-brinkmann deleted the bug/early_lateral_energy_fraction_documentation branch March 18, 2026 11:29
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

bug Something isn't working

Projects

Status: Done

Development

Successfully merging this pull request may close these issues.

3 participants