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: udpate defstruct docs with mention of field spec; add example; #586

Merged
merged 1 commit into from
Dec 4, 2023
Merged

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

merged 1 commit into from
Dec 4, 2023

Conversation

alexei
Copy link
Contributor

@alexei alexei commented Nov 18, 2023

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

Addresses #580

@alexei
Copy link
Contributor Author

alexei commented Nov 18, 2023

@jcrist I suppose the documentation site is generated automatically?

@jcrist
Copy link
Owner

jcrist commented Dec 4, 2023

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.

@jcrist jcrist merged commit 3556137 into jcrist:main Dec 4, 2023
8 checks passed
@alexei
Copy link
Contributor Author

alexei commented Dec 4, 2023

Thanks!

@alexei alexei deleted the docs-defstruct branch December 4, 2023 22:11
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.

2 participants