Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: client/llb: missing documentation for most llb exported identifiers #5534

Open
profnandaa opened this issue Nov 19, 2024 · 1 comment

Comments

@profnandaa
Copy link
Collaborator

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:
Image

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.

/assign @castrombithisamm

@castrombithisamm
Copy link
Contributor

Thanks @profnandaa , I will take this up, but I might need some assistance.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants