From ae8e68bc4abbd726e0aed587f22b60a80da546a3 Mon Sep 17 00:00:00 2001
From: Giuseppe Gadola <giusgadola@gmail.com>
Date: Thu, 9 Feb 2023 01:15:25 +0100
Subject: docs: added some basic comments to explain functions

---
 lua/pets/pet.lua | 4 ++++
 1 file changed, 4 insertions(+)

(limited to 'lua/pets/pet.lua')

diff --git a/lua/pets/pet.lua b/lua/pets/pet.lua
index 30e3461..f1f04c3 100644
--- a/lua/pets/pet.lua
+++ b/lua/pets/pet.lua
@@ -2,6 +2,10 @@ local M = {}
 M.Pet = {}
 M.Pet.__index = M.Pet
 
+-- @param name the actual name for the pet
+-- @param type the species of the pet e.g. cat
+-- @param style the color/style of the pet e.g. brown
+-- @return a new Pet instance
 function M.Pet.new(name, type, style)
     local instance = setmetatable({}, M.Pet)
     instance.name = name
-- 
cgit v1.3-2-g11bf