Skip to content

Fix sample README drift: wrong flag, fork links, missing requirements, wrong variable names - #119

Open
ZayanKhan-12 wants to merge 4 commits into
tableau:mainfrom
ZayanKhan-12:docs/fix-sample-readmes
Open

Fix sample README drift: wrong flag, fork links, missing requirements, wrong variable names#119
ZayanKhan-12 wants to merge 4 commits into
tableau:mainfrom
ZayanKhan-12:docs/fix-sample-readmes

Conversation

@ZayanKhan-12

Copy link
Copy Markdown

Four commits, each independently revertible:

  1. git-to-hyper — the documented run commands use --path_to_repo, but both scripts define path_to_repo as a positional argument (the README's own embedded usage output shows this); as written the commands exit with unrecognized arguments.
  2. Community-Supported index — the s3-compatible-services and git-to-hyper entries linked the contributor's fork (github.com/aetperf/...) instead of this repository, unlike every other entry.
  3. s3-compatible-services — the README instructs installing dependencies from requirements.txt, but the sample shipped without one; added it with the sample's only third-party import (tableauhyperapi, same pin as the sibling native-s3 sample).
  4. hyper-to-csv — the usage instructions tell users to change hyper_name and my_table; the script's variables are hyper_file_path and table_name (the documented names exist nowhere in the script).

Verification: argparse definitions and variable names grep-verified against each script; both corrected index targets exist in this repo; python -m py_compile clean on all touched samples. (The repository has no test suite or CI to run.)

Prepared with AI assistance (Claude).

zk-khan and others added 4 commits July 26, 2026 20:13
Both scripts define path_to_repo as a positional argument (the README's
own embedded usage output shows this), so the documented commands exit
with 'unrecognized arguments: --path_to_repo'.

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
The s3-compatible-services and git-to-hyper index entries linked the
contributor's fork (aetperf) instead of tableau/hyper-api-samples like
every other entry.

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
The README instructs installing dependencies from requirements.txt, but
the sample shipped without one; the script's only third-party import is
tableauhyperapi (same pin as the sibling native-s3 sample).

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
The script's variables are hyper_file_path and table_name; hyper_name
and my_table exist nowhere in hyper-to-csv.py.

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
@salesforce-cla

Copy link
Copy Markdown

Thanks for the contribution! Before we can merge this, we need @zk-khan to sign the Salesforce Inc. Contributor License Agreement.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants