Docs/document hybrid params#358
Open
Shaurya2k06 wants to merge 2 commits into
Open
Conversation
Document every parameter on the 30 public methods that previously had only a <summary>, including boost, so IntelliSense matches the rest of the query/generate API. Signed-off-by: shaurya2k06 <shaurya2k06@gmail.com>
Add ci/check_xml_param_docs.py to fail when a public QueryClient, GenerateClient, or typed query/generate method has a <summary> but missing or incomplete <param> tags. Wire it into preflight so Hybrid-style gaps cannot regress silently. Signed-off-by: shaurya2k06 <shaurya2k06@gmail.com>
![orca-security-eu[bot]](https://avatars.githubusercontent.com/in/276244?s=60&v=4){kind=small}
There was a problem hiding this comment.
Orca Security Scan Summary
| Status | Check | Issues by priority | |
|---|---|---|---|
 Passed |
Secrets |  0  0  0  0 |
View in Orca |
|
To avoid any confusion in the future about your contribution to Weaviate, we work with a Contributor License Agreement. If you agree, you can simply add a comment to this PR that you agree with the CLA so that we can merge. |
Author
|
agree |
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
2 participants
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.
Summary
<param>documentation to the 30 public query/generate methods that previously had only a<summary>(all Hybrid overloads on Query/Generate + typed clients, 4 GenerateNearVectoroverloads, and 2 NearText extension overloads).QueryClient.NearVector/ BM25 (The limit,The alpha, …); copy theboostline verbatim from the rest of the public API. Rich boost prose stays onModels/Boost.cs.ci/check_xml_param_docs.pyand wire it into preflight so methods with a<summary>but missing/incomplete<param>tags fail CI on the Query/Generate (+ typed) surface — closes the CS1573/CS1591 blind spot that let this gap persist.feat/boost-query-apiso these methods are fully documented includingboostonce that lands. No behavior or public API surface changes.Test plan
dotnet build src/Weaviate.Client/→ 0 errorsdotnet test --filter "FullyQualifiedName~Unit"→ 877 passed / 0 failed / 2 skippedpython3 ci/check_xml_param_docs.py→ passesWeaviate.Client.xmlincludesboost,alpha,filters, etc. on Hybrid / Generate Hybrid / NearText extension overloadsFixes #357