Merged
Conversation
…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.
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
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.
Add extensive documentation improvements across the entire codebase:
The documentation now provides developers with clear, copy-paste ready examples for every feature, making the library significantly more accessible and easier to use.