From 8d8944b7d9349ab2156791bebdedfff42928a750 Mon Sep 17 00:00:00 2001
From: Dimitri Papadopoulos
 <3234522+DimitriPapadopoulos@users.noreply.github.com>
Date: Mon, 3 Jul 2023 13:03:29 +0200
Subject: [PATCH] More documentation for "sample frequency"

It turns out "sample frequency" is actually the number of samples per
channel/signal in EDFlib:
https://www.teuniz.net/edflib/doc/edflib_8h.html#a11d03849cecc17a2599125a1a102b69e

We inherit this strange definition, and need to explain it.
---
 pyedflib/edfreader.py | 11 +++++++----
 1 file changed, 7 insertions(+), 4 deletions(-)

diff --git a/pyedflib/edfreader.py b/pyedflib/edfreader.py
index 2730f62..799132e 100644
--- a/pyedflib/edfreader.py
+++ b/pyedflib/edfreader.py
@@ -370,11 +370,10 @@ def getStartdatetime(self):
 
     def getBirthdate(self, string=True):
         """
-        Returns the birthdate as string object
+        Returns the birthdate as a string.
 
         Parameters
         ----------
-        None
 
         Examples
         --------
@@ -393,7 +392,9 @@ def getBirthdate(self, string=True):
 
     def getSampleFrequencies(self):
         """
-        Returns  samplefrequencies of all signals.
+        Returns the number of samples for all channels.
+
+        The effective sample frequency is samplefrequency / duration.
 
         Parameters
         ----------
@@ -413,7 +414,9 @@ def getSampleFrequencies(self):
 
     def getSampleFrequency(self, chn):
         """
-        Returns the samplefrequency of signal edfsignal.
+        Returns the number of samples in given channel.
+
+        The effective sample frequency is samplefrequency / duration.
 
         Parameters
         ----------