From 1aa3a012e8700d54fa5c7039ea5b1177c347f9e9 Mon Sep 17 00:00:00 2001
From: Tomi Hakala <tomi.hakala@pobox.fi>
Date: Sun, 26 May 2024 14:00:31 +0300
Subject: [PATCH] chore: add comments

---
 internal/conf/consts.go | 9 +++++----
 1 file changed, 5 insertions(+), 4 deletions(-)

diff --git a/internal/conf/consts.go b/internal/conf/consts.go
index 838c641a..9e4e32e0 100644
--- a/internal/conf/consts.go
+++ b/internal/conf/consts.go
@@ -1,10 +1,11 @@
+// conf/consts.go hard coded constants
 package conf
 
 const (
-	SampleRate    = 48000
-	BitDepth      = 16
-	NumChannels   = 1
-	CaptureLength = 3
+	SampleRate    = 48000 // Sample rate of the audio fed to BirdNET Analyzer
+	BitDepth      = 16    // Bit depth of the audio fed to BirdNET Analyzer
+	NumChannels   = 1     // Number of channels of the audio fed to BirdNET Analyzer
+	CaptureLength = 3     // Length of audio data fed to BirdNET Analyzer in seconds
 
 	SpeciesConfigCSV  = "species_config.csv"
 	SpeciesActionsCSV = "species_actions.csv"