Repository navigation
docs: Fix Python SDK credential examples, env default, and stale links - #285
Open
promptless[bot] wants to merge 1 commit into
Open
promptless[bot] wants to merge 1 commit into
promptless[bot] wants to merge 1 commit into
Conversation
|
✅ Gitleaks Findings: No secrets detected. Safe to proceed! |
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.
Open in Promptless
Why
The Python SDK docs include a credentials example that raises
SkyflowErrorand claim thatenvdefaults toPROD. The SDK has no default and fails whenenvis omitted. The docs also describe credential precedence wrongly.Goal
docs/advanced_initialization.md: wrap the service account as{'credentials_string': ...}soadd_skyflow_credentials()accepts it.skyvault/README.md,flowvault/README.md,docs/auth_credentials.md: say that passing more than one credential raisesSkyflowError. Remove the claim thatenvdefaults toPRODhere and indocs/migrate_to_v2.md.docs/migrate_to_v2.md: correct theInsertRequestparameter (table). Fix stale links left by the common/skyvault/flowvault split, broken../README.mdlinks, and the samples README link and run command. Fix a misleading env-var name, a stale version banner, and inconsistent indentation.flowvault/samples/vault_api/insert_records.pyalso has the wrong comment "PROD (default)".README.rstisn't used as the PyPI long description, and whether to keep it is the team's decision.Testing
maincommit. Review comments on this PR link each correction to the source line that supports it.Trigger Events