search

nandlabs / go-commons

A common collection of utilities for Go programming language
Apache License 2.0
2 stars 2 forks source link

Utils inline code documentation #56

Closed nandagopalan closed 1 year ago

nandagopalan commented 1 year ago

Any package/collection of functions that does not have a specific feature in itself should have a details inline documentation of the functions.

nandagopalan commented 1 year ago

Current packages

  1. errutils
  2. fnutils
  3. textutils
nandagopalan commented 1 year ago

It is better to have the naming convention with utils as suffix for these packages to be easily identified.

The main readme can have one utils section and link to GODocs for reference