Skip to content

Add OData usage examples to read_azure_table() docs#128

Merged
francisbarton merged 2 commits into
mainfrom
copilot/add-examples-to-read-azure-table
Jun 11, 2026
Merged

Add OData usage examples to read_azure_table() docs#128
francisbarton merged 2 commits into
mainfrom
copilot/add-examples-to-read-azure-table

Conversation

Copilot AI commented Jun 11, 2026

Copy link
Copy Markdown
Contributor

read_azure_table() did not show how to use OData query strings in practice. This updates the function docs with generic, non-executed examples for common query patterns so users can quickly see how to apply filter, select, and top.

  • Documentation

    • Added @examples to read_azure_table() in the roxygen source.
    • Kept the generated .Rd manual page in sync.
  • Examples added

    • Basic table read with a generic endpoint
    • OData filtering via filter
    • Combined filter, select, and top usage
  • Example

    read_azure_table(
      "my_table",
      table_endpoint = "https://myaccount.table.core.windows.net/",
      filter = "Status eq 'Active' and Score ge 10",
      select = "PartitionKey,RowKey,Status,Score",
      top = 100
    )

Copilot AI changed the title [WIP] Add examples to read_azure_table function documentation Add OData usage examples to read_azure_table() docs Jun 11, 2026
Copilot AI requested a review from tomjemmett June 11, 2026 15:07
@tomjemmett tomjemmett marked this pull request as ready for review June 11, 2026 17:37
Copilot AI review requested due to automatic review settings June 11, 2026 17:37

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

This PR improves the package documentation for read_azure_table() by adding practical, non-executed examples that demonstrate common OData query patterns (basic read, filter, and combined filter/select/top). This aligns with the repo’s convention of keeping roxygen source in R/ and generated .Rd docs in man/ in sync.

Changes:

  • Added @examples to read_azure_table() roxygen docs showing typical OData usage (filter, select, top).
  • Regenerated/updated the corresponding man/read_azure_table.Rd so the manual page matches the roxygen source.

Reviewed changes

Copilot reviewed 1 out of 2 changed files in this pull request and generated no comments.

File Description
R/read_azure_table.R Adds roxygen @examples demonstrating OData query usage for read_azure_table().
man/read_azure_table.Rd Updates generated Rd documentation to include the new examples.
Files not reviewed (1)
  • man/read_azure_table.Rd: Language not supported

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

@francisbarton francisbarton left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

awesome

@francisbarton francisbarton merged commit 1801fc6 into main Jun 11, 2026
2 checks passed
@francisbarton francisbarton deleted the copilot/add-examples-to-read-azure-table branch June 11, 2026 19:13
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants