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

Add docstring and flatten param types for schema builder methods #407

Open
wants to merge 10 commits into
base: main
Choose a base branch
from

Conversation

zxl629
Copy link
Contributor

@zxl629 zxl629 commented Dec 3, 2024

Description of changes:

This change introduces docstrings on all data model builder methods to demonstrate proper invocation. It also adds type alias to present clearer types for customers.

Example of why we need this:

Before the change:
.authorization()
Screenshot 2024-12-04 at 2 10 59 PM

After the change:

.authorization()

Screenshot 2024-12-04 at 2 14 09 PM

.identifier()

Screenshot 2024-12-04 at 2 14 36 PM

.disableOperations()

Screenshot 2024-12-04 at 2 15 34 PM

.secondaryIndexes()

Screenshot 2024-12-04 at 2 15 15 PM

By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.

Copy link

changeset-bot bot commented Dec 3, 2024

🦋 Changeset detected

Latest commit: 0987bd2

The changes in this PR will be included in the next version bump.

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

@zxl629 zxl629 marked this pull request as ready for review December 4, 2024 22:19
@zxl629 zxl629 requested review from a team as code owners December 4, 2024 22:19
@iartemiev iartemiev changed the base branch from feat/reinvent-blocked-days/main to main December 9, 2024 12:23
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