search

jcrist / msgspec

A fast serialization and validation library, with builtin support for JSON, MessagePack, YAML, and TOML
https://jcristharif.com/msgspec/
BSD 3-Clause "New" or "Revised" License
2.3k stars 67 forks source link

docs: udpate `defstruct` docs with mention of field spec; add example; #586

Closed alexei closed 10 months ago

alexei commented 10 months ago

Update defstruct docs to mention it's possible to use msgspec.field.

Addresses https://github.com/jcrist/msgspec/issues/580

alexei commented 10 months ago

@jcrist I suppose the documentation site is generated automatically?

jcrist commented 10 months ago

Thanks for the PR (and apologies for the delayed response)! I've pushed a small fixup, but otherwise this looks good to me.

I suppose the documentation site is generated automatically?

Yes, it's built and deployed as part of CI. If you want to build locally see https://github.com/jcrist/msgspec/blob/main/.github/CONTRIBUTING.md#documentation.

alexei commented 10 months ago

Thanks!