changeset 442:44dcd2c4d860

Update latex code in docstring
author Amine Sehili <amine.sehili@gmail.com>
date Thu, 31 Oct 2024 09:06:39 +0100
parents 6cf3ea23fadb
children 0fec1621aa3f dde9d076e6ee
files auditok/signal.py auditok/util.py
diffstat 2 files changed, 2 insertions(+), 2 deletions(-) [+]
line wrap: on
line diff
--- a/auditok/signal.py	Thu Oct 31 08:26:18 2024 +0100
+++ b/auditok/signal.py	Thu Oct 31 09:06:39 2024 +0100
@@ -90,7 +90,7 @@
     The energy is calculated as:
 
     .. math::
-       \text{energy} = 20 \log\left(\sqrt{\frac{1}{N} \sum_{i=1}^{N} a_i^2}\right) % # noqa: W605
+       \\text{energy} = 20 \\log(\\sqrt({1}/{N} \\sum_{i=1}^{N} {a_i}^2))  % # noqa: W605
 
     where `a_i` is the i-th audio sample and `N` is the total number of samples
     in `x`.
--- a/auditok/util.py	Thu Oct 31 08:26:18 2024 +0100
+++ b/auditok/util.py	Thu Oct 31 09:06:39 2024 +0100
@@ -260,7 +260,7 @@
     as:
 
     .. math::
-        energy = 20 \log(\sqrt({1}/{N} \sum_{i=1}^{N} {a_i}^2))  % # noqa: W605
+        \\text{energy} = 20 \\log(\\sqrt({1}/{N} \\sum_{i=1}^{N} {a_i}^2))  % # noqa: W605
 
     where `a_i` represents the i-th audio sample.