Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: Improve documentation for IDynamoDBContext's Load and LoadAsync #3320

Merged
merged 1 commit into from
May 20, 2024

Conversation

ashovlin
Copy link
Member

@ashovlin ashovlin commented May 15, 2024

Description

Improve documentation for IDynamoDBContext's Load and LoadAsync highlighting that they always rely on the table's primary key and not an override index.

Motivation and Context

#1748 & DOTNET-4899 -Load looks like it can be called using an index's key (as opposed to the table's primary key) by specifying the index name

Testing

Built DynamoDB solution locally

Types of changes

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to change)

Checklist

  • My code follows the code style of this project
  • My change requires a change to the documentation
  • I have updated the documentation accordingly
  • I have read the README document
  • I have added tests to cover my changes
  • All new and existing tests passed

License

  • I confirm that this pull request can be released under the Apache 2 license

…, highlighting that they always rely on the table's primary key and not an override index.
@ashovlin ashovlin requested review from normj and 96malhar May 16, 2024 15:00
@ashovlin ashovlin merged commit 83054cc into main-staging May 20, 2024
2 checks passed
@ashovlin ashovlin deleted the shovlia/ddb-load-docs branch May 20, 2024 17:40
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.

3 participants