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

doc starts with complicated stuff, before talking about the easy approach #31

Open
hughperkins opened this issue Dec 23, 2023 · 1 comment

Comments

@hughperkins
Copy link

chili is easy to use. Just do:

chili.encode(some_object)

or

chili.json_encode(some_object)

... but the doc currently talks about creating Encoder objects, annotating classes, etc, which is super complicated, and totally unnecessary for basic usage.

Strongly suggest starting with the easy way to use chili. Then afer tha, you can have a section "Advanced" to talk about more fancythings.

@hughperkins
Copy link
Author

(also, for the class annotaiton requiremetn, something liek:

"Chili works with any dataclass. If you want to use chili with an object which is not a dataclass, you can also choose to annotate it with [insert chili annotaiton class here]"

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

No branches or pull requests

1 participant