docs(azure): fix Azure Table Storage package name and complete options list#791
docs(azure): fix Azure Table Storage package name and complete options list#791MFA-G wants to merge 2 commits into
Conversation
- Correct package name from `@azure/data-table` to `@azure/data-tables` in the install instructions (the published package and the driver import both use the plural `data-tables`). - Remove the broken empty `[data-tables]()` link. - Complete the truncated Options list: document `sasKey`, `connectionString` and `pageSize` to match the driver options. - Fix authentication note that referenced a non-existent `sasToken` option (the option is `sasKey`). Fixes unjs#681
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: defaults Review profile: CHILL Plan: Pro Run ID: 📒 Files selected for processing (1)
🚧 Files skipped from review as they are similar to previous changes (1)
📝 WalkthroughWalkthroughUpdates the Azure Table Storage docs to rework the usage text, correct the install package name, and expand authentication and options documentation for ChangesAzure Table Storage documentation
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~5 minutes Poem
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✨ Finishing Touches🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
There was a problem hiding this comment.
Actionable comments posted: 1
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@docs/2.drivers/azure.md`:
- Around line 255-256: The authentication precedence text for `sasKey` and
`connectionString` is backwards in the Azure driver docs. Update those
descriptions in the Azure markdown so they match the fallback chain implemented
in `AzureStorageTable` initialization logic from
`src/drivers/azure-storage-table.ts` (where `accountKey`, then `sasKey`, then
`connectionString` are chosen via `else if`). Make `sasKey` say it is only used
when `accountKey` is not provided, and make `connectionString` say it is only
used when neither `accountKey` nor `sasKey` is provided.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
…ey > connectionString)
|
Good catch. Fixed in 4a1059d — the precedence is |
Fixes #681
The Azure Table Storage driver docs had a few inaccuracies, all verified against
src/drivers/azure-storage-table.ts:Wrong package name
The install instructions referenced
@azure/data-table, but the published package — and the driver's own import (from "@azure/data-tables") — use the plural@azure/data-tables. Following the old instructions installs a non-existent package. Fixed both the prose and the:pm-installblock.Broken link
Removed the dangling
[data-tables]()line, which rendered as an empty link.Incomplete options list
The Options list was truncated mid-entry (a dangling
-) and only documentedaccountName,tableName,partitionKeyandaccountKey. Added the missing options to matchAzureStorageTableOptions:sasKey— SAS key forAzureSASCredentialconnectionString— connection string (Node.js only)pageSize— entries per request, defaults to1000(also the max, enforced in the driver)Auth note fix
The
AzureSASCredentialauthentication bullet referenced asasTokenoption that doesn't exist; the actual option issasKey.Docs-only change. No code touched.
Summary by CodeRabbit
pageSizesetting with its default and maximum.