Docs 13 reimagined #56
Merged
Conversation
This file contains 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
still TODO: Conditions."Query, Scan"
Comparing the previous documentation to other projects (especially pytest, flask) I think I was trying to cover absolutely every aspect, in as much detail as possible. That seemed reasonable at the time, because I'm familiar with the code. Stepping back, it seems unapproachable in its sudden depth. I'm going to try another approach that walks through different options as users might discover them. That also means staying away from "this is how DynamoDB works" as much as possible. That can live in a section in the future if it's something people want.
This has flipped at least twice already, but writing the documentation really drove home how odd this felt as a single arg. If you find yourself describing a param as "an object or list of objects" and the arg is named "obj" it's time to just use VARARGS.
Almost done! Need to finish Properties in Query/Scan.
Didn't know ..attribute existed, and now it's beautiful. My hacked-together attempt was failing as the notes expanded past speciying a default value. :party-parrot:
Still incomplete in types: * TypedMap * Map * Custom Types
Now for 05_conditions! So close!
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.
Rewrite docs entirely. This finally closes #13 🎉
A few code changes. Note some of these would require minor and major version bumps after 1.0.0
Engineuses *vararg instead of hand-rolling the same effectprojection,hash_key,range_keykwargs for Index classes are now required, instead of hand-rolling the exceptions