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
Quite a number of exported identifiers (types, variables, functions) are not documented within the source code.
This leaves the published package on pkg.go.dev/.../llb very scantily documented. For instance, there's no Overview, functions like Readonly, WriteTo, are not documented, etc:
It is best practice that any exported identifiers (especially publicly published) be documented.
Solution
We propose that we start slowly documenting, especially the major identifiers; file-by-file (to make it easy to resolve merge conflicts). For instance, we could start with adding a package Overview docstring in client/llb/definition.go and move to all exports in fileop.go, etc.
Problem
Quite a number of exported identifiers (types, variables, functions) are not documented within the source code.
This leaves the published package on pkg.go.dev/.../llb very scantily documented. For instance, there's no Overview, functions like
Readonly
,WriteTo
, are not documented, etc:It is best practice that any exported identifiers (especially publicly published) be documented.
Solution
We propose that we start slowly documenting, especially the major identifiers; file-by-file (to make it easy to resolve merge conflicts). For instance, we could start with adding a package Overview docstring in
client/llb/definition.go
and move to all exports infileop.go
, etc./assign @castrombithisamm
The text was updated successfully, but these errors were encountered: