docs: add PHPDoc blocks to all constant declarations (closes #63)#164
Merged
Conversation
Added detailed PHPDoc blocks before all constant declarations across: - src/ZVec.php (57 constants) - src/ZVecSchema.php (4 constants) - src/ZVecDoc.php (4 constants) Each block documents the constant's purpose, numeric value, cross-reference to the zvec C++ enum, and @see links to consumer methods.
The DOC-004 changes added numeric values in PHPDoc blocks (e.g. 'Value: 67108864 (64 MB)'). The magic number test now filters out PHPDoc comment lines when checking for hardcoded values.
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.
Description
Closes #63
Changes
src/ZVec.php— 57 constants (index types, query params, log types/levels, buffer sizes, HNSW defaults, scalar/vector/array data types, quantize types)src/ZVecSchema.php— 4 constants (METRIC_L2, METRIC_IP, METRIC_COSINE, METRIC_MIPSL2)src/ZVecDoc.php— 4 constants (OP_INSERT, OP_UPDATE, OP_UPSERT, OP_DELETE)@seelinks to consumer methods[Unreleased] - AddedTesting
php -lpasses on all 3 modified files.phpttests pass (same results as main: 97 pass, 47 pre-existing failures)Code Review