Skip to content

Conversation

@allisson
Copy link
Owner

Add extensive documentation improvements across the entire codebase:

  • Add comprehensive package-level documentation to query.go explaining library purpose, basic usage, filter syntax, and supported database flavors
  • Enhance all 7 public function docs with detailed parameter descriptions, return value explanations, and practical code examples
  • Document all 4 private helper functions (parseIn, parseSelectFilter, parseUpdateFilter, parseDeleteFilter) explaining their purpose and behavior
  • Improve type documentation in options.go with detailed field descriptions for all 4 option types (FindOptions, FindAllOptions, UpdateOptions, DeleteOptions)
  • Enhance all 16 method documentation with clearer descriptions and usage guidance
  • Completely rewrite README.md with 30+ code examples covering:
    • Basic usage for SELECT, INSERT, UPDATE, DELETE operations
    • Advanced filtering with complete operator reference table
    • Pagination and ordering examples
    • Row locking (FOR UPDATE) with various modes
    • Struct-based query building with tag examples
    • Database flavor handling for MySQL, PostgreSQL, SQLite
    • Four complete real-world examples (user management, e-commerce order processing, data cleanup, product search)

The documentation now provides developers with clear, copy-paste ready examples for every feature, making the library significantly more accessible and easier to use.

…godoc comments

Add extensive documentation improvements across the entire codebase:
- Add comprehensive package-level documentation to query.go explaining library purpose, basic usage, filter syntax, and supported database flavors
- Enhance all 7 public function docs with detailed parameter descriptions, return value explanations, and practical code examples
- Document all 4 private helper functions (parseIn, parseSelectFilter, parseUpdateFilter, parseDeleteFilter) explaining their purpose and behavior
- Improve type documentation in options.go with detailed field descriptions for all 4 option types (FindOptions, FindAllOptions, UpdateOptions, DeleteOptions)
- Enhance all 16 method documentation with clearer descriptions and usage guidance
- Completely rewrite README.md with 30+ code examples covering:
  - Basic usage for SELECT, INSERT, UPDATE, DELETE operations
  - Advanced filtering with complete operator reference table
  - Pagination and ordering examples
  - Row locking (FOR UPDATE) with various modes
  - Struct-based query building with tag examples
  - Database flavor handling for MySQL, PostgreSQL, SQLite
  - Four complete real-world examples (user management, e-commerce order processing, data cleanup, product search)
The documentation now provides developers with clear, copy-paste ready examples for every feature, making the library significantly more accessible and easier to use.
@allisson allisson merged commit 51b3888 into main Jan 20, 2026
1 check passed
@allisson allisson deleted the update-docs branch January 20, 2026 12:08
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants