From 87a914324865e676421e0d91e5c3aa562e4079e9 Mon Sep 17 00:00:00 2001
From: Andrew Scott <git@acscott.dev>
Date: Tue, 26 Jul 2022 19:42:25 -0400
Subject: [PATCH] Added some basic documentation

---
 server/current.go  | 2 ++
 server/extended.go | 2 ++
 server/main.go     | 4 ++++
 3 files changed, 8 insertions(+)

diff --git a/server/current.go b/server/current.go
index 3bd8e0a..432896c 100644
--- a/server/current.go
+++ b/server/current.go
@@ -10,6 +10,8 @@ import (
 	pb "codeberg.org/andcscott/OpenWeatherMap-gRPC-API/proto"
 )
 
+// Receives a gRPC request for the current forecast
+// Returns a SendCurrent message containing the forecast in JSON
 func (s *Server) Current(ctx context.Context, in *pb.RequestCurrent) (*pb.SendCurrent, error) {
 	log.Println("'Current' function called...")
 
diff --git a/server/extended.go b/server/extended.go
index 5d81017..2c82710 100644
--- a/server/extended.go
+++ b/server/extended.go
@@ -11,6 +11,8 @@ import (
 	pb "codeberg.org/andcscott/OpenWeatherMap-gRPC-API/proto"
 )
 
+// Receives a gRPC request for an extended forecast
+// Returns a SendExtended message with the forecast in JSON
 func (s *Server) Extended(ctx context.Context, in *pb.RequestExtended) (*pb.SendExtended, error) {
 	log.Println("'Extended' function called...")
 
diff --git a/server/main.go b/server/main.go
index 22ee58d..7bcfbc1 100644
--- a/server/main.go
+++ b/server/main.go
@@ -18,13 +18,16 @@ type Server struct {
 
 func main() {
 
+	// Load .env file
 	err := godotenv.Load()
 	if err != nil {
 		log.Fatalln(err)
 	}
 
+	// Read PORT from .env
 	port, _ := strconv.Atoi(os.Getenv("PORT"))
 
+	// Start server
 	lis, err := net.Listen("tcp", fmt.Sprintf(":%d", port))
 	if err != nil {
 		log.Fatalf("Error starting server: %v\n", err)
@@ -32,6 +35,7 @@ func main() {
 		log.Printf("Listening on port %d...\n", port)
 	}
 
+	// Initialize gRPC server
 	s := grpc.NewServer()
 	pb.RegisterWeatherServiceServer(s, &Server{})
 	if err = s.Serve(lis); err != nil {