Update Command and Function description comments throughout the project.

cmd/init.go

@@ -11,6 +11,7 @@ func Init(configName string) error {
 	return nil
 }
 
+// Update the Init Directory variable in the config
 func UpdateInit(configuration *config.AppConfig, configName string) error {
 	err := config.UpdateInitDirectory(configuration, configName)
 	if err != nil {

cmd/remove.go

@@ -9,10 +9,10 @@ import (
 	"github.com/SwayKh/linksym/pkg/utils"
 )
 
-// Get the "LinkName" as an argument, which should be the path relative to the
-// Init Directory, and Find the matching LinkName through the []Records in
-// .linksym.yaml, UnLink it, and Remove from the []Records.
-// Expects one argument, and throws error on multiple arguments provided
+// Get the absolute path of "LinkName", which should be the path relative from
+// the Init Directory, and Find the matching LinkName through the []Records in
+// .linksym.yaml, UnLink it, and Remove from the []Records. Expects one
+// argument, and throws error on multiple arguments provided
 func Remove(configuration *config.AppConfig, args []string) error {
 	switch len(args) {
 	case 1:
@@ -26,6 +26,7 @@ func Remove(configuration *config.AppConfig, args []string) error {
 		} else if !linkPath.Exists {
 			return fmt.Errorf("File %s doesn't exist", linkPath.AbsPath)
 		}
+
 		// Since the "filename" of the record can be the same with a different file,
 		// just linked in separate directories, getting the filename and the above
 		// directory name should make the name unique enough to be checked in

main.go

@@ -32,7 +32,7 @@ func Run() error {
 	// Since the Init Command creates the config file, the LoadConfig function
 	// can't be called before handling the init subcommand.
 	// But Init function calls aliasPath, which requires HomeDirectory variable,
-	// and hence function SetupDirectories was split up
+	// and InitialiseHomePath needs be called before this.
 	cmd.InitFlag.Parse(os.Args[2:])
 	if flag.Arg(0) == "init" && !cmd.UpdateInitBool {
 		return cmd.Init(configName)

pkg/config/config.go

@@ -6,13 +6,6 @@ import (
 	"github.com/SwayKh/linksym/pkg/utils"
 )
 
-// This package should, create the default config with the initialised directory
-// Read the config for every other command to work and use the variable vales
-// Add data under the "Links" variable whenever a new config is add via the
-// project.
-// The config file can be either .json .ini .toml .yaml
-// I think yaml is a good file format for this
-
 type AppConfig struct {
 	InitDirectory string   `yaml:"init_directory"`
 	Records       []record `yaml:"records"`
@@ -52,6 +45,7 @@ func (c *AppConfig) RemoveRecord(name string) {
 	}
 }
 
+// Un-Alias all paths with ~ and $init_directory with full absolute paths
 func UnAliasConfig(configuration *AppConfig) {
 	configuration.InitDirectory = utils.ExpandPath(configuration.InitDirectory)
 
@@ -62,6 +56,7 @@ func UnAliasConfig(configuration *AppConfig) {
 	}
 }
 
+// Alias all mentions of HomeDirectory and InitDirectory with ~ and $init_directory
 func AliasConfig(configuration *AppConfig) {
 	configuration.InitDirectory = utils.AliasPath(configuration.InitDirectory, true)
 

pkg/config/io.go

@@ -10,7 +10,7 @@ import (
 )
 
 // Load the configuration from .linksym.yaml configuration file and unmarshall
-// it into the global Configuration variable, and un-alias all paths
+// it into the global Configuration variable, and return pointer to this struct
 func LoadConfig(configPath string) (*AppConfig, error) {
 	// Check if config file exists
 	config, err := utils.GetFileInfo(configPath)
@@ -41,8 +41,7 @@ func LoadConfig(configPath string) (*AppConfig, error) {
 	return configuration, nil
 }
 
-// Write the Configuration struct data to .linksym.yaml file after aliasing all
-// paths with ~ and $init_directory
+// Write the Configuration struct data to .linksym.yaml file
 func WriteConfig(configuration *AppConfig, configPath string) error {
 	data, err := yaml.Marshal(configuration)
 	if err != nil {
@@ -78,6 +77,9 @@ func InitialiseConfig(configPath string) error {
 	return nil
 }
 
+// Takes *AppConfig as argument, updates the init_directory variables with
+// current directory while keeping the []Records intact. And Write config back
+// to file.
 func UpdateInitDirectory(configuration *AppConfig, configPath string) error {
 	InitDirectory, err := os.Getwd()
 	if err != nil {

pkg/linker/link.go

@@ -29,8 +29,7 @@ func MoveAndLink(sourcePath, destinationPath string, isDirectory bool) error {
 	return nil
 }
 
-// Create a symlink of source path at the destination path, and create a record
-// of it
+// Create a symlink of source path at the destination path,
 func Link(sourcePath, destinationPath string) error {
 	err := os.Symlink(destinationPath, sourcePath)
 	if err != nil {
@@ -40,7 +39,7 @@ func Link(sourcePath, destinationPath string) error {
 }
 
 // Remove the symlink file at the source, move the destination file to the
-// original source path. Undoing the MoveAndLink function basically
+// original source path. Basically undo-ing the MoveAndLink function
 func UnLink(sourcePath, destinationPath string, isDirectory bool) error {
 	err := deleteFile(sourcePath)
 	if err != nil {

pkg/utils/utils.go

@@ -76,11 +76,14 @@ func AliasPath(path string, skipInitDir bool) string {
 	return path
 }
 
+// Set values to global variables of InitDirectory and ConfigPath
 func SetupDirectories(initDir string, configName string) {
 	global.InitDirectory = ExpandPath(initDir)
 	global.ConfigPath = filepath.Join(global.InitDirectory, configName)
 }
 
+// Set the global HomeDirectory variable. Separated from SetupDirectories to be
+// used with the Init Subcommand.
 func InitialiseHomePath() error {
 	var err error
 	global.HomeDirectory, err = os.UserHomeDir()