From 62b487ed9da06cd564237ef4df81cf2cffa11af9 Mon Sep 17 00:00:00 2001 From: Paul Buetow Date: Wed, 25 Mar 2026 00:00:40 +0200 Subject: cmd/gt: add comprehensive package documentation - Enhanced Package gt documentation with detailed usage examples for percentage calculations and RPN expressions - Added architecture overview section - Enhanced Package internal documentation with version format, build instructions, and usage examples - All tests pass and application builds correctly --- internal/version.go | 45 +++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 45 insertions(+) (limited to 'internal') diff --git a/internal/version.go b/internal/version.go index 2137e45..24a97ea 100644 --- a/internal/version.go +++ b/internal/version.go @@ -1,3 +1,48 @@ +// Package internal provides version information for the gt application. +// +// This package contains internal constants that are used across the gt project. +// It is not intended for direct use by external code and may change without notice. +// +// Package Location +// +// The internal package is located at internal/version.go and contains: +// - Version: Current application version string +// +// Version Format +// +// The version string follows semantic versioning (SemVer) format: +// - Major.Minor.Patch (e.g., "v0.3.0") +// - Pre-release versions may include suffixes like "-beta", "-rc1", etc. +// - Build metadata may be appended for development builds +// +// Usage in Code +// +// To access the version from the main command: +// +// import "codeberg.org/snonux/perc/internal" +// +// func main() { +// fmt.Println("gt version", internal.Version) +// } +// +// Version History +// +// Current: v0.3.0 +// +// See the git repository for complete version history and release notes. package internal +// Version is the current version of the gt application. +// +// This constant is defined at build time and can be overridden during builds: +// go build -ldflags="-X 'codeberg.org/snonux/perc/internal.Version=v0.3.0-20240324'" +// +// The version is used in: +// - Command-line output: "gt version" command +// - Help and about information +// - Error messages and diagnostics +// +// Example output: +// $ gt version +// v0.3.0 const Version = "v0.3.0" -- cgit v1.2.3