Error string should not be capitalized or end with the punctuation mark

[CatalinStratu]

Error strings should not be capitalized (unless beginning with proper nouns or acronyms) or end with punctuation, since they are usually printed following other context. That is, use fmt.Errorf("something bad") not fmt.Errorf("Something bad"), so that log.Printf("Reading %s: %v", filename, err) formats without a spurious capital letter mid-message. This does not apply to logging, which is implicitly line-oriented and not combined inside other messages.

Source: https://github.com/golang/go/wiki/CodeReviewComments#error-strings

[CatalinStratu]

Hi, @lumjjb please review.

[CatalinStratu]

@swinslow and @RishabhBhatnagar, what do you think about this PR?

[RishabhBhatnagar]

avoid adding Function names before the function unless the following statement captures the intent of the function.

[RishabhBhatnagar]

Same comment here and in the other files as well.

[RishabhBhatnagar]

This is kind of a cosmetic change. I haven't kept track of other PRs.
I'm afraid that it might cause merge conflicts for them.

[lumjjb]

Hi @CatalinStratu ! Yes you are right, this will likely merge conflict with the PR that @kzantow is working on: #172, which involves a major refactor, can we put this on hold until that PR gets in and apply the changes once that gets merged? Which should be before the end of the month 🤞

[kzantow]

Hi @CatalinStratu -- apologies for the large number of conflicts! There has been a significant refactoring to make this library easier for consumers; are you able to adjust this PR for the changes?

[CatalinStratu]

Hi, @kzantow will adapt this PR for the new changes.

[lumjjb]

Closing from inactivity, opened #216 to track since this seems valuable.