docs

sidi762 · Feb 17, 2024 · 4a2a1b5 · 4a2a1b5
1 parent b7d0bdf
commit 4a2a1b5
Show file tree

Hide file tree

Showing 2 changed files with 4 additions and 5 deletions.
diff --git a/hearme/__init__.py b/hearme/__init__.py
@@ -1,8 +1,7 @@
 """
-This module initializes the digital signal processing package, 
-providing tools for encoding, decoding, and signal detection. 
-It facilitates the conversion of textual information into modulated signals 
-and vice versa, supporting various encoding schemes and modulation techniques.
+This module initializes the acoustic signal processing package, 
+providing tools  for encoding and decoding text into audio signals 
+for acoustic data transmission.
 Liang Sidi, 2024
 """
 from . import decoder, detector, encoder

diff --git a/hearme/detector.py b/hearme/detector.py
@@ -1,6 +1,6 @@
 """
 Implements signal detection logic to identify the presence 
-of digital signals using the microphone (with pyaudio). 
+of sound signals using the microphone (with pyaudio). 
 This module includes methods for preamble detection, 
 signal strength analysis, and synchronization to facilitate 
 accurate decoding.