docs(go): add godoc comments to all exported types and functions - #5
Merged
Conversation
### What Adds godoc comments to every exported type, function, method, variable and constant across the root package, plus a package-level doc comment on goods.go. ### Why pkg.go.dev was effectively empty: no exported symbol had a doc comment. This PR lets users discover the API through `go doc` and the Go documentation website, which is a strong signal of library maturity and a prerequisite before growing the surface further. ### Notes - No behavior change; every comment is informational. - Follows stdlib conventions: short phrase, starts with the symbol name. - Covers 112+ exported methods on *File plus sentinel errors, style types, cell helpers, iterators, range builder and utility funcs.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What
Adds godoc comments to every exported type, function, method, variable and constant across the root package, plus a package-level doc on
goods.go.Why
pkg.go.dev/github.com/mukbeast4/go-odswas effectively empty — no exported symbol had a doc comment. This PR unlocks discoverability viago docand the Go documentation website, which is a strong signal of library maturity and a prerequisite before expanding the surface further.Notes
*Fileplus sentinel errors, style types, cell helpers, iterators, range builder, coord utilities and formula helpers.go test -race,go vet,gofmt -lall clean.Test plan
go test -count=1 -race ./...passesgofmt -l .silentgo vet ./...silentgo doc github.com/mukbeast4/go-ods NewFilerenders useful text