Add OData usage examples to read_azure_table() docs#128
Merged
Conversation
Copilot
AI
changed the title
[WIP] Add examples to
Add OData usage examples to Jun 11, 2026
read_azure_table function documentationread_azure_table() docs
Contributor
There was a problem hiding this comment.
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
@examplestoread_azure_table()roxygen docs showing typical OData usage (filter,select,top). - Regenerated/updated the corresponding
man/read_azure_table.Rdso 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.
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.
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 applyfilter,select, andtop.Documentation
@examplestoread_azure_table()in the roxygen source..Rdmanual page in sync.Examples added
filterfilter,select, andtopusageExample