Repository navigation
docs: Fix docstring argument names that do not match the signature - #7098
Merged
Merged
Conversation
Several Args entries named a parameter the function does not have. Rename them to the actual parameter or drop them, and update the DecisionEvaluator example, which passed a DecisionStrategy that the constructor does not accept. Signed-off-by: mmporong <[email protected]>
|
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## master #7098 +/- ##
=======================================
Coverage 50.99% 50.99%
=======================================
Files 455 455
Lines 56994 56994
Branches 8321 8321
=======================================
Hits 29063 29063
Misses 25946 25946
Partials 1985 1985
Continue to review full report in Codecov by Harness.
🚀 New features to boost your workflow:
|
jyejare
pushed a commit
to opendatahub-io/feast
that referenced
this pull request
Nov 5, 2026
* feat: Add Pinecone online store integration (feast-dev#6585) * feat: Add Pinecone online store integration Signed-off-by: Siddhesh Khairnar <[email protected]> * fix: Align Pinecone store with filters API and operator types Signed-off-by: Siddhesh Khairnar <[email protected]> * test: Expand Pinecone online store unit test coverage Signed-off-by: Siddhesh Khairnar <[email protected]> * fix: Address Pinecone online store review feedback Signed-off-by: Siddhesh Khairnar <[email protected]> * ci: Retrigger CI after flaky macOS dependency download Signed-off-by: Siddhesh Khairnar <[email protected]> * fix: Resolve rebase conflicts keeping chronon and pinecone Signed-off-by: Siddhesh Khairnar <[email protected]> * fix: Prevent protobuf downgrade breaking grpc health checks Signed-off-by: Siddhesh Khairnar <[email protected]> * fix: Revert protobuf pin that broke flink and pixi lock Keep uv --no-sync for CI so hashed protobuf 7.x is preserved without conflicting with feast[flink]. Signed-off-by: Siddhesh Khairnar <[email protected]> --------- Signed-off-by: Siddhesh Khairnar <[email protected]> * fix: Install patched libbrotli1 to address DSA-6582-1 (feast-dev#7096) Signed-off-by: Joystyxx <[email protected]> Co-authored-by: Shuchu Han <[email protected]> * docs: Fix docstring argument names that do not match the signature (feast-dev#7098) Several Args entries named a parameter the function does not have. Rename them to the actual parameter or drop them, and update the DecisionEvaluator example, which passed a DecisionStrategy that the constructor does not accept. Signed-off-by: mmporong <[email protected]> Co-authored-by: Shuchu Han <[email protected]> * chore(deps-dev): bump minimatch from 10.2.6 to 11.0.1 in /ui (feast-dev#7102) Bumps [minimatch](https://github.com/isaacs/minimatch) from 10.2.6 to 11.0.1. - [Changelog](https://github.com/isaacs/minimatch/blob/main/changelog.md) - [Commits](isaacs/minimatch@v10.2.6...v11.0.1) --- updated-dependencies: - dependency-name: minimatch dependency-version: 11.0.1 dependency-type: direct:development ... Signed-off-by: dependabot[bot] <[email protected]> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> --------- Signed-off-by: Siddhesh Khairnar <[email protected]> Signed-off-by: Joystyxx <[email protected]> Signed-off-by: mmporong <[email protected]> Signed-off-by: dependabot[bot] <[email protected]> Signed-off-by: Chaitany Patel <[email protected]> Co-authored-by: Siddhesh Khairnar <[email protected]> Co-authored-by: JoyStyx <[email protected]> Co-authored-by: Shuchu Han <[email protected]> Co-authored-by: Lim Jooyoung <[email protected]> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
jyejare
pushed a commit
to opendatahub-io/feast
that referenced
this pull request
Nov 5, 2026
…ges) (#281) * feat: Add Pinecone online store integration (feast-dev#6585) * feat: Add Pinecone online store integration Signed-off-by: Siddhesh Khairnar <[email protected]> * fix: Align Pinecone store with filters API and operator types Signed-off-by: Siddhesh Khairnar <[email protected]> * test: Expand Pinecone online store unit test coverage Signed-off-by: Siddhesh Khairnar <[email protected]> * fix: Address Pinecone online store review feedback Signed-off-by: Siddhesh Khairnar <[email protected]> * ci: Retrigger CI after flaky macOS dependency download Signed-off-by: Siddhesh Khairnar <[email protected]> * fix: Resolve rebase conflicts keeping chronon and pinecone Signed-off-by: Siddhesh Khairnar <[email protected]> * fix: Prevent protobuf downgrade breaking grpc health checks Signed-off-by: Siddhesh Khairnar <[email protected]> * fix: Revert protobuf pin that broke flink and pixi lock Keep uv --no-sync for CI so hashed protobuf 7.x is preserved without conflicting with feast[flink]. Signed-off-by: Siddhesh Khairnar <[email protected]> --------- Signed-off-by: Siddhesh Khairnar <[email protected]> * fix: Install patched libbrotli1 to address DSA-6582-1 (feast-dev#7096) Signed-off-by: Joystyxx <[email protected]> Co-authored-by: Shuchu Han <[email protected]> * docs: Fix docstring argument names that do not match the signature (feast-dev#7098) Several Args entries named a parameter the function does not have. Rename them to the actual parameter or drop them, and update the DecisionEvaluator example, which passed a DecisionStrategy that the constructor does not accept. Signed-off-by: mmporong <[email protected]> Co-authored-by: Shuchu Han <[email protected]> * chore(deps-dev): bump minimatch from 10.2.6 to 11.0.1 in /ui (feast-dev#7102) Bumps [minimatch](https://github.com/isaacs/minimatch) from 10.2.6 to 11.0.1. - [Changelog](https://github.com/isaacs/minimatch/blob/main/changelog.md) - [Commits](isaacs/minimatch@v10.2.6...v11.0.1) --- updated-dependencies: - dependency-name: minimatch dependency-version: 11.0.1 dependency-type: direct:development ... Signed-off-by: dependabot[bot] <[email protected]> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> --------- Signed-off-by: Siddhesh Khairnar <[email protected]> Signed-off-by: Joystyxx <[email protected]> Signed-off-by: mmporong <[email protected]> Signed-off-by: dependabot[bot] <[email protected]> Signed-off-by: Chaitany Patel <[email protected]> Co-authored-by: Siddhesh Khairnar <[email protected]> Co-authored-by: JoyStyx <[email protected]> Co-authored-by: Shuchu Han <[email protected]> Co-authored-by: Lim Jooyoung <[email protected]> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
jyejare
added a commit
to opendatahub-io/feast
that referenced
this pull request
Nov 5, 2026
… only, do not squash) (#283) * feat: Add Pinecone online store integration (feast-dev#6585) * feat: Add Pinecone online store integration Signed-off-by: Siddhesh Khairnar <[email protected]> * fix: Align Pinecone store with filters API and operator types Signed-off-by: Siddhesh Khairnar <[email protected]> * test: Expand Pinecone online store unit test coverage Signed-off-by: Siddhesh Khairnar <[email protected]> * fix: Address Pinecone online store review feedback Signed-off-by: Siddhesh Khairnar <[email protected]> * ci: Retrigger CI after flaky macOS dependency download Signed-off-by: Siddhesh Khairnar <[email protected]> * fix: Resolve rebase conflicts keeping chronon and pinecone Signed-off-by: Siddhesh Khairnar <[email protected]> * fix: Prevent protobuf downgrade breaking grpc health checks Signed-off-by: Siddhesh Khairnar <[email protected]> * fix: Revert protobuf pin that broke flink and pixi lock Keep uv --no-sync for CI so hashed protobuf 7.x is preserved without conflicting with feast[flink]. Signed-off-by: Siddhesh Khairnar <[email protected]> --------- Signed-off-by: Siddhesh Khairnar <[email protected]> * fix: Install patched libbrotli1 to address DSA-6582-1 (feast-dev#7096) Signed-off-by: Joystyxx <[email protected]> Co-authored-by: Shuchu Han <[email protected]> * docs: Fix docstring argument names that do not match the signature (feast-dev#7098) Several Args entries named a parameter the function does not have. Rename them to the actual parameter or drop them, and update the DecisionEvaluator example, which passed a DecisionStrategy that the constructor does not accept. Signed-off-by: mmporong <[email protected]> Co-authored-by: Shuchu Han <[email protected]> * chore(deps-dev): bump minimatch from 10.2.6 to 11.0.1 in /ui (feast-dev#7102) Bumps [minimatch](https://github.com/isaacs/minimatch) from 10.2.6 to 11.0.1. - [Changelog](https://github.com/isaacs/minimatch/blob/main/changelog.md) - [Commits](isaacs/minimatch@v10.2.6...v11.0.1) --- updated-dependencies: - dependency-name: minimatch dependency-version: 11.0.1 dependency-type: direct:development ... Signed-off-by: dependabot[bot] <[email protected]> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> --------- Signed-off-by: Siddhesh Khairnar <[email protected]> Signed-off-by: Joystyxx <[email protected]> Signed-off-by: mmporong <[email protected]> Signed-off-by: dependabot[bot] <[email protected]> Signed-off-by: Chaitany Patel <[email protected]> Co-authored-by: Siddhesh Khairnar <[email protected]> Co-authored-by: JoyStyx <[email protected]> Co-authored-by: Shuchu Han <[email protected]> Co-authored-by: Lim Jooyoung <[email protected]> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
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.
What this PR does / why we need it:
Fixes docstring
Argsentries that name a parameter the function does not have. Docstrings only, no code changes.BaseRegistry.delete_project:project->nameinit_security_manager(feast/permissions/server/utils.py):registry->fs. The function takes theFeatureStoreand readsfs.projectandfs.registry.DecisionEvaluator: removeddecision_strategy. The constructor only takesnum_of_votersand always usesAFFIRMATIVE, so the summary line now says that instead of "according to the selected strategy". The example in the same docstring calledDecisionEvaluator(DecisionStrategy.UNANIMOUS, 3), which raisesTypeError: DecisionEvaluator.__init__() takes 2 positional arguments but 3 were given, so it now readsDecisionEvaluator(3). Also fixed in the same file: the "receivem" typo in that example, and in theadd_grantdocstringvote->grantand "Trueis" -> "Trueif".Project.from_proto:entity_proto->project_proto, and theReturnsline now says it returns a Project (it said "An Entity object based on the entity protobuf"). "an project" -> "a project" in the same docstring.Provider.retrieve_online_documents_v2:query->embeddingconfigure_ca_trust_store_env_variables: removed:param ca_file_path:. The function takes no arguments and readsFEAST_CA_CERT_FILE_PATHfrom the environment._proto_value_to_value_type(feast/type_map.py):proto_str->proto_value, and the summary line now says it takes a proto value.These were found with a script that parses each function with
astand compares the names in its docstring parameter section with the signature. Before this change it reported 12 entries undersdk/python/feast, after it 5, none of which is a wrong name:created_timestampandlast_updated_timestampin theDataSourceclass docstring are attributes listed underArgs,Versions:inserialize_entity_keyis a heading inside an argument description, andstart_date/end_dateinProvider.get_historical_featuresgo through**kwargs.Checks run locally (Python 3.12):
ruff check sdk/python/feast/ sdk/python/tests/andruff format --checkon the changed files, ruff 0.16.10 as pinned insdk/python/requirements/py3.12-ci-requirements.txt: passmypy1.11.2 on the 7 changed files, run fromsdk/python: no issuespytest tests/unit/permissions tests/unit/test_project.py tests/unit/test_type_map.py -k "not TestSparkNativeTypeValidation": 657 passed, the same as on master. The 24 deselected tests need pyspark, which was not installed.DecisionEvaluatorexample againstfeast/permissions/decision.py: the old one raises theTypeErrorabove, the new one runs and returns a decision.Which issue(s) this PR fixes:
None, there is no issue for this.
Checks
git commit -s)Testing Strategy
Misc