You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Our library lacks documentation, especially about what features/packages are available, what they do and how to use them. We could use Godoc for package documentation also providing usage examples. Go's gob package is a good example of how to do this (in great detail).
I would start by documenting the config, logging and version packages, as these are most likely to be used when starting a new component. In addition, we could also introduce a scaffold where all this is used, plus an example of signal processing with signal.NotifyContext().
The text was updated successfully, but these errors were encountered:
Our library lacks documentation, especially about what features/packages are available, what they do and how to use them. We could use Godoc for package documentation also providing usage examples. Go's gob package is a good example of how to do this (in great detail).
I would start by documenting the
config
,logging
andversion
packages, as these are most likely to be used when starting a new component. In addition, we could also introduce a scaffold where all this is used, plus an example of signal processing withsignal.NotifyContext()
.The text was updated successfully, but these errors were encountered: