Add comments for functions

Author: Vic Shóstak

README.md

@@ -1,6 +1,6 @@
 # json2csv – Parse JSON files to CSV with data qualifier
 
-![Go version][go_version_img]
+[![Go version][go_version_img]][json2csv_go_dev_url]
 [![Go report][go_report_img]][go_report_url]
 ![Code coverage][code_coverage_img]
 [![Wiki][wiki_img]][wiki_url]
@@ -97,4 +97,5 @@ robots by [Vic Shóstak][author].
 [license_img]: https://img.shields.io/badge/license-Apache_2.0-red?style=for-the-badge&logo=none
 [license_url]: https://github.com/koddr/json2csv/blob/main/LICENSE
 [json2csv_url]: https://github.com/koddr/json2csv
+[json2csv_go_dev_url]: https://pkg.go.dev/github.com/koddr/json2csv
 [author]: https://github.com/koddr

config.go

@@ -2,6 +2,7 @@ package main
 
 import "os"
 
+// config presents struct for the configuration.
 type config struct {
 	outputFolder string
 	contentField string
@@ -12,6 +13,7 @@ type config struct {
 	chunkSize    int
 }
 
+// jsonFolder presents struct for the folder with JSON sources.
 type jsonFolder struct {
 	path  string
 	files []os.DirEntry

filter.go

@@ -7,6 +7,7 @@ import (
 	jsoniter "github.com/json-iterator/go"
 )
 
+// filter provides rule sets for the input string to skip specified values.
 func (c *config) filter(s string) bool {
 	// Skip empty strings.
 	if s == "" {

parser.go

@@ -9,6 +9,7 @@ import (
 	jsoniter "github.com/json-iterator/go"
 )
 
+// parse provides the parsing process.
 func (c *config) parse() error {
 	// Create slice for results.
 	results := make([]map[string]string, 0, len(c.jsonFolder.files))

qualifier.go

@@ -7,6 +7,7 @@ import (
 	jsoniter "github.com/json-iterator/go"
 )
 
+// qualify provides a qualifier for the given string.
 func (c *config) qualify(s string) string {
 	// Skip empty strings.
 	if s == "" {

save_to_csv.go

@@ -7,13 +7,19 @@ import (
 	"time"
 )
 
+// save provides saving operation for source map.
 func (c *config) save(source []map[string]string) error {
 	// Create a new file to collect CSV data.
 	outputFile, err := os.Create(fmt.Sprintf("%s/%d.csv", c.outputFolder, time.Now().Unix()))
 	if err != nil {
 		return err
 	}
-	defer outputFile.Close()
+	defer func(outputFile *os.File) {
+		err := outputFile.Close()
+		if err != nil {
+
+		}
+	}(outputFile)
 
 	// Write the header of the CSV file and the successive rows by iterating through
 	// the JSON struct array.

session.go

@@ -6,7 +6,11 @@ import (
 	"path/filepath"
 )
 
-func newSession(jsonPath, intentsPath, filterPath, outputPath, contentField string, minWordLen, chunkSize int) (*config, error) {
+// newSession provides init configuration for the parsing session.
+func newSession(
+	jsonPath, intentsPath, filterPath, outputPath, contentField string,
+	minWordLen, chunkSize int,
+) (*config, error) {
 	if minWordLen < 0 {
 		return nil, errors.New("can't parse data with negative word count")
 	}